Documentation

Application

Table of Contents

Interfaces

Clock
CarbonDoctrineType
ConstraintInterface
DO NOT IMPLEMENT this interface. It is only meant for usage as a type hint in libraries relying on composer/semver but creating your own constraint class that implements this interface is not a supported use case and will cause the composer/semver components to return unexpected results.
DataInterface
Reader
Interface for annotation readers.
LanguageInflectorFactory
WordInflector
FieldFactoryInterface
FieldInterface
CRON field interface.
CommentStrategy
Reason
Result
EmailValidation
ContainerInterface
Describes the interface of a container that exposes methods to read its entries.
AddressExtension
An extension is the only way to add new functionality to Faker.
BarcodeExtension
An extension is the only way to add new functionality to Faker.
BloodExtension
An extension is the only way to add new functionality to Faker.
ColorExtension
An extension is the only way to add new functionality to Faker.
CompanyExtension
An extension is the only way to add new functionality to Faker.
CountryExtension
An extension is the only way to add new functionality to Faker.
DateTimeExtension
FakerPHP extension for Date-related randomization.
Extension
An extension is the only way to add new functionality to Faker.
FileExtension
An extension is the only way to add new functionality to Faker.
GeneratorAwareExtension
An extension is the only way to add new functionality to Faker.
NumberExtension
An extension is the only way to add new functionality to Faker.
PersonExtension
An extension is the only way to add new functionality to Faker.
PhoneNumberExtension
An extension is the only way to add new functionality to Faker.
UuidExtension
An extension is the only way to add new functionality to Faker.
VersionExtension
An extension is the only way to add new functionality to Faker.
RequestMethodInterface
Defines constants for common HTTP request methods.
StatusCodeInterface
Defines constants for common HTTP status code.
HandlerInterface
InspectorFactoryInterface
InspectorInterface
RunInterface
JWTExceptionWithPayloadInterface
ExternalAccountCredentialSourceInterface
FetchAuthTokenInterface
An interface implemented by objects that can fetch auth tokens.
GetQuotaProjectInterface
An interface implemented by objects that can get quota projects.
GetUniverseDomainInterface
An interface implemented by objects that can get universe domain for Google Cloud APIs.
ProjectIdProviderInterface
Describes a Credentials object which supports fetching the project ID.
SignBlobInterface
Describes a class which supports signing arbitrary strings.
UpdateMetadataInterface
Describes a Credentials object which supports updating request metadata (request headers).
ClosureSerializerInterface
An interface for serializing closures.
ConfigStorageInterface
An interface for storing the configuration.
JobInterface
The JobInterface represents any job that can be serialized and run in a separate process via the Batch daemon.
ProcessItemInterface
An interface for processing the items.
ReaderInterface
Defines a metadata reader implementation.
IamConnectionInterface
An interface defining how wrappers interact with their IAM implementations.
LockInterface
Contract for a basic locking mechanism.
MetadataProviderInterface
An interface for provide some metadata for reports.
HeaderCredentialsInterface
MiddlewareInterface
Middlewares must take a MiddlewareInterface as their first constructor argument {@see Google\ApiCore\Middleware\ResponseMetadataMiddleware}, which represents the next middleware in the chain. This next middleware MUST be invoked by this MiddlewareInterface, and the result must be returned as part of the `__invoke` method implementation.
UnaryInterceptorInterface
Temporary class to support an interceptor-like interface until gRPC interceptor support is available.
TransportInterface
CallInvoker
CallInvoker is used to pass the self defined channel into the stub, while intercept each RPC with the channel accessible.
BodySummarizerInterface
ClientInterface
Client interface for sending HTTP requests.
CookieJarInterface
Stores HTTP cookies.
GuzzleException
Every HTTP client related exception MUST implement this interface.
CurlFactoryInterface
MessageFormatterInterface
PromiseInterface
A promise represents the eventual result of an asynchronous operation.
PromisorInterface
Interface used with classes that return a promise.
TaskQueueInterface
Description
A description of a Matcher. A Matcher will describe itself to a description which can later be used for reporting.
Matcher
A matcher over acceptable values.
SelfDescribing
The ability of an object to describe itself.
ActionCodeSettings
AppCheck
Auth
Database
The Firebase Realtime Database.
DynamicLinks
Firestore
Messaging
RemoteConfig
The Firebase Remote Config.
Storage
AppCheckException
AuthException
DatabaseException
FirebaseException
MessagingException
RemoteConfigException
Message
Request
Handler
Handler
Handler
Handler
Expirable
Keys
Token
TokenRepositoryInterface
BatchRepository
PrunableBatchRepository
Enumerable
CommandMutex
NewLineAware
CacheAware
EventMutex
SchedulingMutex
Authorizable
Gate
Authenticatable
CanResetPassword
Factory
Guard
AuthenticatesRequests
MustVerifyEmail
PasswordBroker
PasswordBrokerFactory
StatefulGuard
SupportsBasicAuth
UserProvider
Broadcaster
Factory
HasBroadcastChannel
ShouldBeUnique
ShouldBroadcast
ShouldBroadcastNow
Dispatcher
QueueingDispatcher
Factory
Lock
LockProvider
Repository
Store
Repository
Application
Isolatable
Kernel
PromptsForMissingInput
Container
Describes the interface of a container that exposes methods to read its entries.
ContextualBindingBuilder
Factory
QueueingFactory
Builder
This interface is intentionally empty and exists to improve IDE support.
Castable
CastsAttributes
CastsInboundAttributes
DeviatesCastableAttributes
SerializesCastableAttributes
SupportsPartialRelations
MigrationEvent
Builder
This interface is intentionally empty and exists to improve IDE support.
ConditionExpression
Expression
ExceptionHandler
Encrypter
StringEncrypter
Dispatcher
ShouldDispatchAfterCommit
ShouldHandleEventsAfterCommit
Cloud
Factory
Filesystem
Application
Describes the interface of a container that exposes methods to read its entries.
CachesConfiguration
CachesRoutes
ExceptionRenderer
MaintenanceMode
Hasher
Kernel
Attachable
Factory
Mailable
Mailer
MailQueue
Dispatcher
Factory
CursorPaginator
LengthAwarePaginator
Paginator
Hub
Pipeline
InvokedProcess
ProcessResult
ClearableQueue
EntityResolver
Factory
Job
Monitor
Queue
QueueableCollection
QueueableEntity
ShouldBeEncrypted
ShouldBeUnique
ShouldBeUniqueUntilProcessing
ShouldQueue
ShouldQueueAfterCommit
Connection
Connector
Factory
BindingRegistrar
Registrar
ResponseFactory
UrlGenerator
UrlRoutable
AuthenticatesSessions
Session
Arrayable
CanBeEscapedWhenCastToString
DeferrableProvider
DeferringDisplayableValue
Htmlable
Jsonable
MessageBag
MessageProvider
Renderable
Responsable
ValidatedData
HasLocalePreference
Loader
Translator
DataAwareRule
Factory
ImplicitRule
InvokableRule
Rule
UncompromisedVerifier
ValidatesWhenResolved
ValidationRule
Validator
ValidatorAwareRule
Engine
Factory
View
ConnectionInterface
ConnectionResolverInterface
ConnectorInterface
Scope
MigrationRepositoryInterface
PotentiallyMissing
ConnectorInterface
CountableFailedJobProvider
FailedJobProviderInterface
PrunableFailedJobProvider
CallableDispatcher
ControllerDispatcher
HasMiddleware
ValidatorInterface
RouteCollectionInterface
ExistenceAwareInterface
Fake
DatabasePresenceVerifierInterface
PresenceVerifierInterface
CompilerInterface
ViewFinderInterface
Scrolling
HasAbilities
HasApiTokens
Serializable
Signer
Builder
ClaimsFormatter
Decoder
Encoder
Exception
Parser
Key
Signer
RegisteredClaims
Defines the list of claims that are registered in the IANA "JSON Web Token Claims" registry
Token
UnencryptedToken
Constraint
SignedWith
ValidAt
Validator
ConverterInterface
Interface for a service which converts content from one format (like Markdown) to another (like HTML).
DelimiterInterface
CacheableDelimiterProcessorInterface
Special marker interface for delimiter processors that return dynamic values from getDelimiterUse()
DelimiterProcessorCollectionInterface
DelimiterProcessorInterface
Interface for a delimiter processor
EnvironmentAwareInterface
EnvironmentBuilderInterface
Interface for building the Environment with any extensions, parsers, listeners, etc. that it may need
EnvironmentInterface
Interface for a service which provides a readable configuration object
CommonMarkException
Marker interface for all exceptions thrown by this library.
ConfigurableExtensionInterface
EmbedAdapterInterface
Interface for a service which updates the embed code(s) for the given array of embeds
ExtensionInterface
FrontMatterDataParserInterface
FrontMatterParserInterface
FrontMatterProviderInterface
MentionGeneratorInterface
NormalizerStrategyInterface
TableOfContentsGeneratorInterface
MarkdownInputInterface
MarkdownConverterInterface
Interface for a service which converts Markdown to HTML.
TightBlockInterface
DelimitedInterface
ExpressionInterface
RawMarkupContainerInterface
Interface for a node which contains raw, unprocessed markup (like HTML)
StringContainerInterface
Interface for a node which directly contains line(s) of text
TextNormalizerInterface
Creates a normalized version of the given input text
UniqueSlugNormalizerInterface
Creates a normalized version of the given input text
RenderedContentInterface
BlockContinueParserInterface
Interface for a block continuation parser
BlockContinueParserWithInlinesInterface
Interface for a block continuation parser
BlockStartParserInterface
Interface for a block parser which identifies block starts.
InlineParserInterface
InlineParserEngineInterface
Parser for inline content (text, links, emphasized text, etc).
MarkdownParserInterface
MarkdownParserStateInterface
ReferenceableInterface
ReferenceInterface
Link reference
ReferenceMapInterface
A collection of references
ChildNodeRendererInterface
Renders multiple nodes by delegating to the individual node renderers and adding spacing where needed
DocumentRendererInterface
Renders a parsed Document AST
MarkdownRendererInterface
Renders a parsed Document AST
NodeRendererInterface
XmlNodeRendererInterface
ConfigurationAwareInterface
Implement this class to facilitate setter injection of the configuration where needed
ConfigurationBuilderInterface
An interface that provides the ability to set both the schema and configuration values
ConfigurationInterface
Interface for reading configuration values
ConfigurationProviderInterface
Interface for a service which provides a readable configuration object
ConfigurationExceptionInterface
Marker interface for any/all exceptions thrown by this library
MutableConfigurationInterface
Interface for setting/merging user-defined configuration values into the configuration object
SchemaBuilderInterface
Interface that allows new schemas to be added to a configuration
ChecksumProvider
FilesystemAdapter
FilesystemException
FilesystemOperationFailed
FilesystemOperator
This interface contains everything to read from and inspect a filesystem. All methods containing are non-destructive.
FilesystemReader
This interface contains everything to read from and inspect a filesystem. All methods containing are non-destructive.
FilesystemWriter
PathNormalizer
StorageAttributes
VisibilityConverter
PublicUrlGenerator
TemporaryUrlGenerator
ExtensionLookup
ExtensionToMimeTypeMap
MimeTypeDetector
FromArray
FromCollection
FromGenerator
FromIterator
FromQuery
FromView
HasReferencesToOtherSheets
OnEachRow
PersistRelations
ShouldAutoSize
ShouldQueueWithoutChain
SkipsEmptyRows
SkipsOnError
SkipsOnFailure
SkipsUnknownSheets
ToArray
ToCollection
ToModel
WithBackgroundColor
WithBatchInserts
WithCalculatedFormulas
WithCharts
WithChunkReading
WithColumnFormatting
WithColumnLimit
WithColumnWidths
WithCustomChunkSize
WithCustomCsvSettings
WithCustomQuerySize
WithCustomStartCell
WithCustomValueBinder
WithDefaultStyles
WithDrawings
WithEvents
WithFormatData
WithGroupedHeadingRow
WithHeadingRow
WithHeadings
WithLimit
WithMappedCells
WithMapping
WithMultipleSheets
WithPreCalculateFormulas
WithProgressBar
WithProperties
WithReadFilter
WithSkipDuplicates
WithStartRow
WithStrictNullComparison
WithStyles
WithTitle
WithUpsertColumns
WithUpserts
WithValidation
LaravelExcelException
Exporter
Importer
TransactionHandler
CountValidatorInterface
MockeryExceptionInterface
ExpectationInterface
Generator
Pass
TargetClassInterface
LegacyMockInterface
Loader
ArgumentListMatcher
MatcherInterface
MockInterface
FormatterInterface
Interface for formatters
ActivationStrategyInterface
Interface for activation strategies for the FingersCrossedHandler.
FormattableHandlerInterface
Interface to describe loggers that have a formatter
HandlerInterface
Interface that all Monolog Handlers must implement
ProcessableHandlerInterface
Interface to describe loggers that have processors
ProcessorInterface
An optional interface to allow labelling Monolog processors.
ResettableInterface
Handler or Processor implementing this interface will be reset when Logger::reset() is called.
Filter
Filter to apply to a property while copying an object
Matcher
TypeFilter
CarbonConverterInterface
CarbonInterface
Common interface for Carbon and CarbonImmutable.
BadMethodCallException
Exception
InvalidArgumentException
RuntimeException
TranslatorStrongTypeInterface
Mark translator using strong type from symfony/translation >= 6.
DynamicParameter
Schema
IHtmlString
ITranslator
Translator adapter.
HtmlStringable
Translator
Translator adapter.
Builder
ErrorHandler
FunctionLike
Node
NodeTraverserInterface
NodeVisitor
Parser
PrettyPrinter
RenderableOnCollisionEditor
Exception
Requirement
VersionConstraint
Exception
Operand
AddressRange
IValueBinder
IRenderer
IComparable
IReader
IReadFilter
ITextElement
WizardInterface
Wizard
IWriter
Exception
Exception
Exception
Exception
FinishedSubscriber
StartedSubscriber
Event
AssertionFailedSubscriber
AssertionSucceededSubscriber
ComparatorRegisteredSubscriber
AfterLastTestMethodCalledSubscriber
AfterLastTestMethodErroredSubscriber
AfterLastTestMethodFinishedSubscriber
AfterTestMethodCalledSubscriber
AfterTestMethodErroredSubscriber
AfterTestMethodFinishedSubscriber
BeforeFirstTestMethodCalledSubscriber
BeforeFirstTestMethodErroredSubscriber
BeforeFirstTestMethodFinishedSubscriber
BeforeTestMethodCalledSubscriber
BeforeTestMethodErroredSubscriber
BeforeTestMethodFinishedSubscriber
PostConditionCalledSubscriber
PostConditionErroredSubscriber
PostConditionFinishedSubscriber
PreConditionCalledSubscriber
PreConditionErroredSubscriber
PreConditionFinishedSubscriber
ConsideredRiskySubscriber
DeprecationTriggeredSubscriber
ErrorTriggeredSubscriber
NoticeTriggeredSubscriber
PhpDeprecationTriggeredSubscriber
PhpNoticeTriggeredSubscriber
PhpunitDeprecationTriggeredSubscriber
PhpunitErrorTriggeredSubscriber
PhpunitWarningTriggeredSubscriber
PhpWarningTriggeredSubscriber
WarningTriggeredSubscriber
DataProviderMethodCalledSubscriber
DataProviderMethodFinishedSubscriber
FinishedSubscriber
PreparationFailedSubscriber
PreparationStartedSubscriber
PreparedSubscriber
ErroredSubscriber
FailedSubscriber
MarkedIncompleteSubscriber
PassedSubscriber
SkippedSubscriber
PrintedUnexpectedOutputSubscriber
MockObjectCreatedSubscriber
MockObjectForAbstractClassCreatedSubscriber
MockObjectForIntersectionOfInterfacesCreatedSubscriber
MockObjectForTraitCreatedSubscriber
MockObjectFromWsdlCreatedSubscriber
PartialMockObjectCreatedSubscriber
TestProxyCreatedSubscriber
TestStubCreatedSubscriber
TestStubForIntersectionOfInterfacesCreatedSubscriber
BootstrapFinishedSubscriber
ConfiguredSubscriber
DeprecationTriggeredSubscriber
EventFacadeSealedSubscriber
ExecutionAbortedSubscriber
ExecutionFinishedSubscriber
ExecutionStartedSubscriber
ExtensionBootstrappedSubscriber
ExtensionLoadedFromPharSubscriber
FinishedSubscriber
GarbageCollectionDisabledSubscriber
GarbageCollectionEnabledSubscriber
GarbageCollectionTriggeredSubscriber
StartedSubscriber
WarningTriggeredSubscriber
FilteredSubscriber
FinishedSubscriber
LoadedSubscriber
SkippedSubscriber
SortedSubscriber
StartedSubscriber
Exception
Subscriber
Tracer
Exception
InvocationStubber
MockObject
Stub
ParametersRule
Test
Exception
Extension
CacheException
Exception interface for all exceptions thrown by an Implementing Library.
CacheItemInterface
CacheItemInterface defines an interface for interacting with objects inside a cache.
CacheItemPoolInterface
CacheItemPoolInterface generates CacheItemInterface objects.
InvalidArgumentException
Exception interface for invalid cache arguments.
ClockInterface
ContainerExceptionInterface
Base interface representing a generic exception in a container.
ContainerInterface
Describes the interface of a container that exposes methods to read its entries.
NotFoundExceptionInterface
No entry was found in the container.
EventDispatcherInterface
Defines a dispatcher for events.
ListenerProviderInterface
Mapper from an event to the listeners that are applicable to that event.
StoppableEventInterface
An Event whose processing may be interrupted when the event has been handled.
ClientExceptionInterface
Every HTTP client related exception MUST implement this interface.
ClientInterface
NetworkExceptionInterface
Thrown when the request cannot be completed because of network issues.
RequestExceptionInterface
Exception for when a request failed.
RequestFactoryInterface
ResponseFactoryInterface
ServerRequestFactoryInterface
StreamFactoryInterface
UploadedFileFactoryInterface
UriFactoryInterface
MessageInterface
HTTP messages consist of requests from a client to a server and responses from a server to a client. This interface defines the methods common to each.
RequestInterface
Representation of an outgoing, client-side request.
ResponseInterface
Representation of an outgoing, server-side response.
ServerRequestInterface
Representation of an incoming, server-side HTTP request.
StreamInterface
Describes a data stream.
UploadedFileInterface
Value object representing a file uploaded through an HTTP request.
UriInterface
Value object representing a URI.
LoggerAwareInterface
Describes a logger-aware instance.
LoggerInterface
Describes a logger instance.
CacheException
Interface used for all types of exceptions thrown by the implementing library.
CacheInterface
InvalidArgumentException
Exception interface for invalid cache arguments.
ContextAware
ContextAware interface.
EnvInterface
Abstraction around environment variables.
Exception
An interface for Psy Exceptions.
Listener
Execution Loop Listener interface.
ReflectorFormatter
Reflector formatter interface.
OutputPager
An output pager is much the same as a regular OutputInterface, but allows the stream to be flushed to a pager periodically.
Autocompleter
Interface \Hoa\Console\Readline\Autocompleter.
EventListenable
Each object which is listenable must implement this interface.
EventSource
Each object which is listenable must implement this interface.
IStream
Interface \Hoa\Stream\IStream\Stream.
StreamBufferable
Interface \Hoa\Stream\IStream\Bufferable.
StreamIn
Interface \Hoa\Stream\IStream\In.
StreamLockable
Interface \Hoa\Stream\IStream\Lockable.
StreamOut
Interface \Hoa\Stream\IStream\Out.
StreamPathable
Interface \Hoa\Stream\IStream\Pathable.
StreamPointable
Interface \Hoa\Stream\IStream\Pointable.
StreamStatable
Interface \Hoa\Stream\IStream\Statable.
StreamTouchable
Interface \Hoa\Stream\IStream\Touchable.
Readline
An interface abstracting the various readline_* functions.
PresenterAware
Presenter injects itself as a dependency to all objects which implement PresenterAware.
Checker
Downloader
ArrayInterface
`ArrayInterface` provides traversable array functionality to data types.
CollectionInterface
A collection represents a group of values, known as its elements.
DoubleEndedQueueInterface
A linear collection that supports element insertion and removal at both ends.
CollectionException
MapInterface
An object that maps keys to values.
TypedMapInterface
A `TypedMapInterface` represents a map of elements where key and value are typed.
QueueInterface
A queue is a collection in which the entities in the collection are kept in order.
UuidBuilderInterface
A UUID builder builds instances of UuidInterface
CodecInterface
A codec encodes and decodes a UUID according to defined rules
NumberConverterInterface
A number converter converts UUIDs from hexadecimal characters into representations of integers and vice versa
TimeConverterInterface
A time converter converts timestamps into representations that may be used in UUIDs
DeprecatedUuidInterface
This interface encapsulates deprecated methods for ramsey/uuid
UuidExceptionInterface
FieldsInterface
UUIDs are comprised of unsigned integers, the bytes of which are separated into fields and arranged in a particular layout defined by the specification for the variant
DceSecurityGeneratorInterface
A DCE Security generator generates strings of binary data based on a local domain, local identifier, node ID, clock sequence, and the current time
NameGeneratorInterface
A name generator generates strings of binary data created by hashing together a namespace with a name, according to a hashing algorithm
RandomGeneratorInterface
A random generator generates strings of random binary data
TimeGeneratorInterface
A time generator generates strings of binary data based on a node ID, clock sequence, and the current time
CalculatorInterface
A calculator performs arithmetic operations on numbers
DceSecurityProviderInterface
A DCE provider provides access to local domain identifiers for version 2, DCE Security, UUIDs
NodeProviderInterface
A node provider retrieves or generates a node ID
TimeProviderInterface
A time provider retrieves the current time
FieldsInterface
RFC 4122 defines fields for a specific variant of UUID
UuidInterface
Also known as a Leach-Salz variant UUID, an RFC 4122 variant UUID is a universally unique identifier defined by RFC 4122
NumberInterface
NumberInterface ensures consistency in numeric values returned by ramsey/uuid
TypeInterface
TypeInterface ensures consistency in typed values returned by ramsey/uuid
UuidFactoryInterface
UuidFactoryInterface defines common functionality all `UuidFactory` instances must implement
UuidInterface
A UUID is a universally unique identifier adhering to an agreed-upon representation format and standard for generation
ValidatorInterface
A validator validates a string as a proper UUID
Exception
Exception
Exception
Exception
Exception
LongestCommonSubsequenceCalculator
DiffOutputBuilderInterface
Defines how an output builder should take a generated diff array and return a string representation of that diff.
Exception
Exception
Exception
ReducedArgumentContract
ArgumentReducer
SnippetProvider
HasSolutionsForThrowable
Interface used for SolutionProviders.
ProvidesSolution
Interface to be used on exceptions that provide their own solution.
RunnableSolution
Solution
SolutionProviderRepository
HasSolutionsForThrowable
Interface used for SolutionProviders.
ProvidesSolution
Interface to be used on exceptions that provide their own solution.
RunnableSolution
Solution
SolutionProviderRepository
Composer
ContextProvider
ContextProviderDetector
ProvidesFlareContext
FlareMiddleware
Time
TruncationStrategy
ConfigManager
AdapterInterface
Interface for adapters managing instances of Symfony's CacheItem.
TagAwareAdapterInterface
Interface for invalidating cached items using tags.
MarshallerInterface
Serializes/unserializes PHP values.
PruneableInterface
Interface extends psr-6 and psr-16 caches to allow for pruning (deletion) of all expired cache items.
ResettableInterface
Resets a pool's local state.
CacheInterface
Covers most simple to advanced caching needs.
CallbackInterface
Computes and returns the cached value of an item.
ItemInterface
Augments PSR-6's CacheItemInterface with support for tags and metadata.
NamespacedPoolInterface
Enables namespace-based invalidation by prefixing keys with backend-native namespace separators.
TagAwareCacheInterface
Allows invalidating cached items using tags.
SignalableCommandInterface
Interface for command reacting to signal.
CommandLoaderInterface
CompletionOutputInterface
Transforms the {@see CompletionSuggestions} object into output readable by the shell completion.
DescriptorInterface
Descriptor interface.
ExceptionInterface
ExceptionInterface.
OutputFormatterInterface
Formatter interface for console output.
OutputFormatterStyleInterface
Formatter style interface for defining styles.
WrappableOutputFormatterInterface
Formatter interface for console output that supports word wrapping.
HelperInterface
HelperInterface is the interface all helpers must implement.
InputAwareInterface
InputAwareInterface should be implemented by classes that depends on the Console Input.
InputInterface
InputInterface is the interface implemented by all input classes.
StreamableInputInterface
StreamableInputInterface is the interface implemented by all input classes that have an input stream.
ConsoleOutputInterface
ConsoleOutputInterface is the interface implemented by ConsoleOutput class.
OutputInterface
OutputInterface is the interface implemented by all Output classes.
StyleInterface
Output style helpers.
ExceptionInterface
Interface for exceptions.
ErrorEnhancerInterface
ErrorRendererInterface
Formats an exception to be used as response content.
EventDispatcherInterface
The EventDispatcherInterface is the central point of Symfony's event listener system.
EventSubscriberInterface
An EventSubscriber knows itself what events it is interested in.
EventDispatcherInterface
Allows providing hooks on domain-specific lifecycles by dispatching events.
RequestExceptionInterface
Interface for Request exceptions.
PeekableRequestRateLimiterInterface
A request limiter which allows peeking ahead.
RequestRateLimiterInterface
A special type of limiter that deals with requests.
RequestMatcherInterface
RequestMatcherInterface is an interface for strategies to match a Request.
AttributeBagInterface
Attributes store.
FlashBagInterface
FlashBagInterface.
FlashBagAwareSessionInterface
Interface for session with a flashbag.
SessionBagInterface
Session Bag store.
SessionFactoryInterface
SessionInterface
Interface for the session.
SessionStorageFactoryInterface
SessionStorageInterface
StorageInterface.
BundleInterface
BundleInterface.
CacheClearerInterface
CacheClearerInterface.
CacheWarmerInterface
Interface for classes able to warm up the cache.
WarmableInterface
Interface for classes that support warming their cache.
ArgumentResolverInterface
An ArgumentResolverInterface instance knows how to determine the arguments for a specific action.
ArgumentValueResolverInterface
Responsible for resolving the value of an argument based on its metadata.
ControllerResolverInterface
A ControllerResolverInterface implementation knows how to determine the controller to execute based on a Request object.
ValueResolverInterface
Responsible for resolving the value of an argument based on its metadata.
ArgumentMetadataFactoryInterface
Builds method argument data.
DataCollectorInterface
DataCollectorInterface.
LateDataCollectorInterface
LateDataCollectorInterface.
HttpExceptionInterface
Interface for HTTP error exceptions.
FragmentRendererInterface
Interface implemented by all rendering strategies.
FragmentUriGeneratorInterface
Interface implemented by rendering strategies able to generate a URL for a fragment.
ResponseCacheStrategyInterface
ResponseCacheStrategyInterface implementations know how to compute the Response cache HTTP header based on the different response cache headers.
StoreInterface
Interface implemented by HTTP cache stores.
SurrogateInterface
HttpKernelInterface
HttpKernelInterface handles a Request to convert it to a Response.
KernelInterface
The Kernel is the heart of the Symfony system.
DebugLoggerInterface
DebugLoggerInterface.
RebootableInterface
Allows the Kernel to be rebooted using a temporary cache directory.
TerminableInterface
Terminable extends the Kernel request/response cycle with dispatching a post response event after sending the response and before shutting down the kernel.
ExceptionInterface
Exception interface for all exceptions thrown by the component.
TransportExceptionInterface
Exception interface for all exceptions thrown by the component.
MailerInterface
Interface for mailers able to send emails synchronously and/or asynchronously.
AuthenticatorInterface
An Authentication mechanism.
TransportFactoryInterface
TransportInterface
Interface for all mailer transports.
BodyRendererInterface
AddressEncoderInterface
ContentEncoderInterface
EncoderInterface
MimeHeaderEncoderInterface
ExceptionInterface
HeaderInterface
A MIME Header.
HtmlToTextConverterInterface
MimeTypeGuesserInterface
Guesses the MIME type of a file.
MimeTypesInterface
Guesses the MIME type of a file.
Stringable
ExceptionInterface
Marker Interface for the Process Component.
ExceptionInterface
ExceptionInterface.
ConfigurableRequirementsInterface
ConfigurableRequirementsInterface must be implemented by URL generators that can be configured whether an exception should be generated when the parameters do not match the requirements. It is also possible to disable the requirements check for URL generation completely.
GeneratorDumperInterface
GeneratorDumperInterface is the interface that all generator dumper classes must implement.
UrlGeneratorInterface
UrlGeneratorInterface is the interface that all URL generator classes must implement.
MatcherDumperInterface
MatcherDumperInterface is the interface that all matcher dumper classes must implement.
RedirectableUrlMatcherInterface
RedirectableUrlMatcherInterface knows how to redirect the user.
RequestMatcherInterface
RequestMatcherInterface is the interface that all request matcher classes must implement.
UrlMatcherInterface
UrlMatcherInterface is the interface that all URL matcher classes must implement.
RequestContextAwareInterface
RouteCompilerInterface
RouteCompilerInterface is the interface that all RouteCompiler classes must implement.
RouterInterface
RouterInterface is the interface that all Router classes must implement.
ResetInterface
Provides a way to reset an object to its initial state.
ServiceCollectionInterface
A ServiceProviderInterface that is also countable and iterable.
ServiceProviderInterface
A ServiceProviderInterface exposes the identifiers and the types of services provided by a container.
ServiceSubscriberInterface
A ServiceSubscriber exposes its dependencies via the static {@link getSubscribedServices} method.
ExceptionInterface
InflectorInterface
SluggerInterface
Creates a URL-friendly slug from a given string.
OperationInterface
Represents an operation on catalogue(s).
CatalogueMetadataAwareInterface
This interface is used to get, set, and delete metadata about the Catalogue.
DumperInterface
DumperInterface is the interface implemented by all translation dumpers.
ExceptionInterface
Exception interface for all exceptions thrown by the component.
ProviderExceptionInterface
Exception interface for all exceptions thrown by the component.
ExtractorInterface
Extracts translation messages from a directory or files to the catalogue.
IntlFormatterInterface
Formats ICU message patterns.
MessageFormatterInterface
LoaderInterface
LoaderInterface is the interface implemented by all translation loaders.
MessageCatalogueInterface
MessageCatalogueInterface.
MetadataAwareInterface
This interface is used to get, set, and delete metadata about the translation messages.
ProviderFactoryInterface
ProviderInterface
TranslationReaderInterface
TranslationReader reads translation messages from translation files.
TranslatorBagInterface
TranslationWriterInterface
TranslationWriter writes translation messages.
LocaleAwareInterface
TranslatableInterface
TranslatorInterface
TimeBasedUidInterface
Interface to describe UIDs that contain a DateTimeImmutable as part of their behaviour.
ClonerInterface
DumperInterface
DumperInterface used by Data objects.
DumpDescriptorInterface
ContextProviderInterface
Interface to provide contextual data about dump data clones sent to a server.
DataDumperInterface
DataDumperInterface for dumping Data objects.
ExceptionInterface
LazyObjectInterface
ExceptionInterface
Exception interface for all exceptions thrown by the component.
ExceptionInterface
LoaderInterface
ParserInterface
AdapterInterface
ReaderInterface
WriterInterface
RepositoryInterface
StoreInterface
AnalyserInterface
AnnotationFactoryInterface
ProcessorInterface

Classes

AdminNotifier
AssignNewWorkCalendar
Base class for all commands.
ClearLogs
Base class for all commands.
ClearTaskCompletionLogs
Base class for all commands.
Kernel
ErrorCodes
Centralized catalog of business-specific error codes.
BusinessRuleException
Handler
UsersExport
UsersExport handles exporting users to Excel with dynamic columns depending on the type (management or mobile) and includes basic styling.
ApiController
AuthController
CalendarApiController
SubtaskApiController
TaskApiController
TaskCompletionLogApiController
UserApiController
Controller
ProfileController
CompanyController
DashboardController
LogController
TaskCompletionLogController
UserAbsenceController
UserController
UserTaskController
WorkCalendarTemplateController
AuthenticatedSessionController
ConfirmablePasswordController
EmailVerificationNotificationController
EmailVerificationPromptController
NewPasswordController
PasswordController
PasswordResetLinkController
RegisteredUserController
VerifyEmailController
WebController
Kernel
Authenticate
CheckPermission
EncryptCookies
PreventRequestsDuringMaintenance
RedirectIfAuthenticated
RoleMiddleware
TrimStrings
TrustHosts
TrustProxies
ValidateSignature
VerifyCsrfToken
StoreOrUpdateCompanyRequest
Request represents an HTTP request.
StoreOrUpdateTaskRequest
Request represents an HTTP request.
StoreOrUpdateUserRequest
Request represents an HTTP request.
UpdateUserPasswordRequest
Request represents an HTTP request.
UserTaskFilterRequest
Request represents an HTTP request.
WorkCalendarTemplateRequest
Request represents an HTTP request.
LoginRequest
Request represents an HTTP request.
SendNotificationRequest
Request represents an HTTP request.
ProfileUpdateRequest
Request represents an HTTP request.
SendToDeviceRequest
Request represents an HTTP request.
SendToMultipleRequest
Request represents an HTTP request.
SendToTopicRequest
Request represents an HTTP request.
Company
Class Company
CompanyPhone
App\Models\CompanyPhone
Log
Notification
Class Notification
NotificationPreference
Class NotificationPreference
Permission
Class Permission
RecurrentTask
Role
RolePermission
Subtask
Task
TaskCompletionLog
User
FcmNotification
LogsClearedNotification
CompanyPolicy
LogPolicy
RolePolicy
TaskPolicy
UserPolicy
AppServiceProvider
AuthServiceProvider
BroadcastServiceProvider
EventServiceProvider
RouteServiceProvider
AuthRepository
Repository class responsible for handling authentication-related database operations and token management.
CompanyRepository
Repository class for handling database interactions related to the Company entity.
LogRepository
Repository class for handling database interactions related to logs.
RecurrentTaskRepository
RoleRepository
Repository class for handling database interactions related to the Role entity.
SubtaskRepository
Repository class for Subtask entity.
TaskCompletionLogRepository
Repository class for handling database interactions related to task completion logs.
TaskRepository
Repository class responsible for managing task data persistence.
UserAbsenceRepository
Repository class for handling calendar-related data persistence.
UserRepository
Repository class for handling database interactions related to the User entity.
WorkCalendarDayRepository
Repository class for handling calendar-related data persistence.
WorkCalendarTemplateRepository
Repository class for handling Work Calendar Template data persistence.
AuthService
Service class responsible for handling authentication logic, abstracting repository calls, and business rules.
CalendarService
Service class for calendar business logic.
CompanyService
Service class for business logic related to companies.
DashboardService
Service class responsible for handling Dashboard logic.
LogService
Service class for business logic related to logs.
SubtaskService
Service class for Subtask entity.
TaskCompletionLogService
TaskService
Service class responsible for handling business logic related to tasks.
UserService
Service class for business logic related to the User entity.
UserTaskService
Service class responsible for handling User Task logic.
SwaggerInfo
AlertMessages
AppLayout
BackToUsersButton
Input
GuestLayout
TooltipInfo
CompanyFactory
NotificationFactory
NotificationPreferenceFactory
PermissionFactory
RecurrentTaskFactory
RoleFactory
RolePermissionFactory
SubtaskFactory
TaskCompletionLogFactory
TaskFactory
UserFactory
WorkCalendarTemplateFactory
CleanDataSeeder
DatabaseSeeder
RolePermissionSeeder
RoleSeeder
TestDataSeeder
AuthenticationTest
EmailVerificationTest
PasswordConfirmationTest
PasswordResetTest
PasswordUpdateTest
RegistrationTest
ExampleTest
ProfileTest
TestCase
ExampleTest
FrozenClock
LocalizedClock
MinuteClock
SystemClock
UTCClock
WrappingClock
InMemoryCache
InvalidArgument
Json
BigDecimal
Immutable, arbitrary-precision signed decimal numbers.
BigInteger
An arbitrary-size integer.
BigNumber
Common interface for arbitrary-precision rational numbers.
BigRational
An arbitrarily large rational number.
DivisionByZeroException
Exception thrown when a division by zero occurs.
IntegerOverflowException
Exception thrown when an integer overflow occurs.
MathException
Base class for all math exceptions.
NegativeNumberException
Exception thrown when attempting to perform an unsupported operation, such as a square root, on a negative number.
NumberFormatException
Exception thrown when attempting to create a number from a string with an invalid format.
RoundingNecessaryException
Exception thrown when a number cannot be represented at the requested scale without rounding.
CarbonImmutableType
CarbonType
DateTimeDefaultPrecision
DateTimeImmutableType
DateTimeType
ComposerAutoloaderInit9c491b8531eec05ba41a11d9276a5749
ClassLoader
ClassLoader implements a PSR-0, PSR-4 and classmap class loader.
InstalledVersions
This class is copied in every Composer installed project and available to all
MatchAllResult
MatchAllStrictGroupsResult
MatchAllWithOffsetsResult
MatchResult
MatchStrictGroupsResult
MatchWithOffsetsResult
PcreException
InvalidRegexPatternRule
Copy of PHPStan's RegularExpressionPatternRule
PregMatchFlags
PregMatchParameterOutTypeExtension
PregMatchTypeSpecifyingExtension
PregReplaceCallbackClosureTypeExtension
UnsafeStrictGroupsCallRule
Preg
Regex
ReplaceResult
UnexpectedNullMatchException
Comparator
CompilingMatcher
Helper class to evaluate constraint by compiling and reusing the code to evaluate
Bound
Constraint
Defines a constraint.
MatchAllConstraint
Defines the absence of a constraint.
MatchNoneConstraint
Blackhole of constraints, nothing escapes it
MultiConstraint
Defines a conjunctive or disjunctive set of constraints.
Interval
Intervals
Helper class generating intervals from constraints
Semver
VersionParser
Version parser.
ConfigFactory
GenerateDocsCommand
Base class for all commands.
L5SwaggerException
Generator
GeneratorFactory
SwaggerAssetController
SwaggerController
Config
L5SwaggerFacade
L5SwaggerServiceProvider
SecurityDefinitions
Data
DataException
Base runtime exception type thrown by this library
InvalidPathException
Thrown when trying to access an invalid path in the data array
MissingPathException
Thrown when trying to access a path that does not exist
Util
Attribute
Annotation that can be used to signal to the parser to check the attribute type during the parsing process.
Attributes
Annotation that can be used to signal to the parser to check the types of all declared attributes during the parsing process.
Enum
Annotation that can be used to signal to the parser to check the available values during the parsing process.
IgnoreAnnotation
Annotation that can be used to signal to the parser to ignore specific annotations during the parsing process.
NamedArgumentConstructor
Annotation that indicates that the annotated class should be constructed with a named argument call.
Required
Annotation that can be used to signal to the parser to check if that attribute is required during the parsing process.
Target
Annotation that can be used to signal to the parser to check the annotation target during the parsing process.
Annotation
Annotations class.
AnnotationException
Description of AnnotationException
AnnotationReader
A reader for docblock annotations.
AnnotationRegistry
DocLexer
Simple lexer for docblock annotations.
DocParser
A parser for docblock annotations.
ImplicitlyIgnoredAnnotationNames
A list of annotations that are implicitly ignored during the parsing process.
IndexedReader
Allows the reader to be used in-place of Doctrine's reader.
PhpParser
Parses a file for namespaces/use/class declarations.
PsrCachedReader
A cache aware annotation reader.
TokenParser
Parses a file for namespaces/use/class declarations.
CachedWordInflector
GenericLanguageInflectorFactory
Inflector
InflectorFactory
Language
NoopWordInflector
Inflectible
InflectorFactory
Rules
Uninflected
Inflectible
InflectorFactory
Rules
Uninflected
Inflectible
InflectorFactory
Rules
Uninflected
Pattern
Patterns
Inflectible
InflectorFactory
Rules
Uninflected
Ruleset
Inflectible
InflectorFactory
Rules
Uninflected
Substitution
Substitutions
Transformation
Transformations
Inflectible
InflectorFactory
Rules
Uninflected
Word
RulesetInflector
Inflects based on multiple rulesets.
AbstractLexer
Base class for writing simple lexers, i.e. for creating small DSLs.
Token
AbstractField
Abstract CRON expression field.
CronExpression
CRON expression parser that can determine whether or not a CRON expression is due to run, the next run date and previous run date of a CRON expression.
DayOfMonthField
Day of month field. Allows: * , / - ? L W.
DayOfWeekField
Day of week field. Allows: * / , - ? L #.
FieldFactory
CRON field factory implementing a flyweight factory.
HoursField
Hours field. Allows: * , / -.
MinutesField
Minutes field. Allows: * , / -.
MonthField
Month field. Allows: * , / -.
EmailLexer
Base class for writing simple lexers, i.e. for creating small DSLs.
EmailParser
EmailValidator
MessageIDParser
Comment
DomainComment
LocalComment
DomainLiteral
DomainPart
DoubleQuote
FoldingWhiteSpace
IDLeftPart
IDRightPart
LocalPart
PartParser
Parser
InvalidEmail
MultipleErrors
AtextAfterCFWS
CharNotAllowed
CommaInDomain
CommentsInIDRight
ConsecutiveAt
ConsecutiveDot
CRLFAtTheEnd
CRLFX2
CRNoLF
DetailedReason
DomainAcceptsNoMail
DomainHyphened
DomainTooLong
DotAtEnd
DotAtStart
EmptyReason
ExceptionFound
ExpectingATEXT
ExpectingCTEXT
ExpectingDomainLiteralClose
ExpectingDTEXT
LabelTooLong
LocalOrReservedDomain
NoDNSRecord
NoDomainPart
NoLocalPart
RFCWarnings
SpoofEmail
UnableToGetDNSRecord
Used on SERVFAIL, TIMEOUT or other runtime and network errors
UnclosedComment
UnclosedQuotedString
UnOpenedComment
UnusualElements
SpoofEmail
ValidEmail
DNSCheckValidation
DNSGetRecordWrapper
DNSRecords
EmptyValidationList
SpoofCheckValidation
MessageIDValidation
MultipleValidationWithAnd
NoRFCWarningsValidation
RFCValidation
AddressLiteral
CFWSNearAt
CFWSWithFWS
Comment
DeprecatedComment
DomainLiteral
EmailTooLong
IPV6BadChar
IPV6ColonEnd
IPV6ColonStart
IPV6Deprecated
IPV6DoubleColon
IPV6GroupCount
IPV6MaxGroups
LocalTooLong
NoDNSMXRecord
ObsoleteDTEXT
QuotedPart
QuotedString
TLD
Warning
HTMLPurifier_Arborize
Converts a stream of HTMLPurifier_Token into an HTMLPurifier_Node, and back again.
HTMLPurifier_AttrCollections
Defines common attribute collections that modules reference
HTMLPurifier_AttrDef_Clone
Dummy AttrDef that mimics another AttrDef, BUT it generates clones with make.
HTMLPurifier_AttrDef_CSS_AlphaValue
Validates a number as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_Background
Validates shorthand CSS property background.
HTMLPurifier_AttrDef_CSS_BackgroundPosition
Validates the value of background-position.
HTMLPurifier_AttrDef_CSS_Border
Validates the border property as defined by CSS.
HTMLPurifier_AttrDef_CSS_Color
Validates Color as defined by CSS.
HTMLPurifier_AttrDef_CSS_Composite
Allows multiple validators to attempt to validate attribute.
HTMLPurifier_AttrDef_CSS_DenyElementDecorator
Decorator which enables CSS properties to be disabled for specific elements.
HTMLPurifier_AttrDef_CSS_Filter
Microsoft's proprietary filter: CSS property
HTMLPurifier_AttrDef_CSS_Font
Validates shorthand CSS property font.
HTMLPurifier_AttrDef_CSS_FontFamily
Validates a font family list according to CSS spec
HTMLPurifier_AttrDef_CSS_Ident
Validates based on {ident} CSS grammar production
HTMLPurifier_AttrDef_CSS_ImportantDecorator
Decorator which enables !important to be used in CSS values.
HTMLPurifier_AttrDef_CSS_Length
Represents a Length as defined by CSS.
HTMLPurifier_AttrDef_CSS_ListStyle
Validates shorthand CSS property list-style.
HTMLPurifier_AttrDef_CSS_Multiple
Framework class for strings that involve multiple values.
HTMLPurifier_AttrDef_CSS_Number
Validates a number as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_Percentage
Validates a Percentage as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_Ratio
Validates a ratio as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_TextDecoration
Validates the value for the CSS property text-decoration
HTMLPurifier_AttrDef_CSS_URI
Validates a URI in CSS syntax, which uses url('http://example.com')
HTMLPurifier_AttrDef_CSS
Validates the HTML attribute style, otherwise known as CSS.
HTMLPurifier_AttrDef_Enum
Validates a keyword against a list of valid values.
HTMLPurifier_AttrDef_HTML_Bool
Validates a boolean attribute
HTMLPurifier_AttrDef_HTML_Class
Implements special behavior for class attribute (normally NMTOKENS)
HTMLPurifier_AttrDef_HTML_Color
Validates a color according to the HTML spec.
HTMLPurifier_AttrDef_HTML_ContentEditable
Base class for all validating attribute definitions.
HTMLPurifier_AttrDef_HTML_FrameTarget
Special-case enum attribute definition that lazy loads allowed frame targets
HTMLPurifier_AttrDef_HTML_ID
Validates the HTML attribute ID.
HTMLPurifier_AttrDef_HTML_Length
Validates the HTML type length (not to be confused with CSS's length).
HTMLPurifier_AttrDef_HTML_LinkTypes
Validates a rel/rev link attribute against a directive of allowed values
HTMLPurifier_AttrDef_HTML_MultiLength
Validates a MultiLength as defined by the HTML spec.
HTMLPurifier_AttrDef_HTML_Nmtokens
Validates contents based on NMTOKENS attribute type.
HTMLPurifier_AttrDef_HTML_Pixels
Validates an integer representation of pixels according to the HTML spec.
HTMLPurifier_AttrDef_Integer
Validates an integer.
HTMLPurifier_AttrDef_Lang
Validates the HTML attribute lang, effectively a language code.
HTMLPurifier_AttrDef_Switch
Decorator that, depending on a token, switches between two definitions.
HTMLPurifier_AttrDef_Text
Validates arbitrary text according to the HTML spec.
HTMLPurifier_AttrDef_URI_Email_SimpleCheck
Primitive email validation class based on the regexp found at http://www.regular-expressions.info/email.html
HTMLPurifier_AttrDef_URI_Email
Base class for all validating attribute definitions.
HTMLPurifier_AttrDef_URI_Host
Validates a host according to the IPv4, IPv6 and DNS (future) specifications.
HTMLPurifier_AttrDef_URI_IPv4
Validates an IPv4 address
HTMLPurifier_AttrDef_URI_IPv6
Validates an IPv6 address.
HTMLPurifier_AttrDef_URI
Validates a URI as defined by RFC 3986.
HTMLPurifier_AttrDef
Base class for all validating attribute definitions.
HTMLPurifier_AttrTransform_Background
Pre-transform that changes proprietary background attribute to CSS.
HTMLPurifier_AttrTransform_BdoDir
Post-trasnform that ensures that bdo tags have the dir attribute set.
HTMLPurifier_AttrTransform_BgColor
Pre-transform that changes deprecated bgcolor attribute to CSS.
HTMLPurifier_AttrTransform_BoolToCSS
Pre-transform that changes converts a boolean attribute to fixed CSS
HTMLPurifier_AttrTransform_Border
Pre-transform that changes deprecated border attribute to CSS.
HTMLPurifier_AttrTransform_EnumToCSS
Generic pre-transform that converts an attribute with a fixed number of values (enumerated) to CSS.
HTMLPurifier_AttrTransform_ImgRequired
Transform that supplies default values for the src and alt attributes in img tags, as well as prevents the img tag from being removed because of a missing alt tag. This needs to be registered as both a pre and post attribute transform.
HTMLPurifier_AttrTransform_ImgSpace
Pre-transform that changes deprecated hspace and vspace attributes to CSS
HTMLPurifier_AttrTransform_Input
Performs miscellaneous cross attribute validation and filtering for input elements. This is meant to be a post-transform.
HTMLPurifier_AttrTransform_Lang
Post-transform that copies lang's value to xml:lang (and vice-versa)
HTMLPurifier_AttrTransform_Length
Class for handling width/height length attribute transformations to CSS
HTMLPurifier_AttrTransform_Name
Pre-transform that changes deprecated name attribute to ID if necessary
HTMLPurifier_AttrTransform_NameSync
Post-transform that performs validation to the name attribute; if it is present with an equivalent id attribute, it is passed through; otherwise validation is performed.
HTMLPurifier_AttrTransform_Nofollow
Adds rel="nofollow" to all outbound links. This transform is only attached if Attr.Nofollow is TRUE.
HTMLPurifier_AttrTransform_SafeEmbed
Processes an entire attribute array for corrections needing multiple values.
HTMLPurifier_AttrTransform_SafeObject
Writes default type for all objects. Currently only supports flash.
HTMLPurifier_AttrTransform_SafeParam
Validates name/value pairs in param tags to be used in safe objects. This will only allow name values it recognizes, and pre-fill certain attributes with required values.
HTMLPurifier_AttrTransform_ScriptRequired
Implements required attribute stipulation for <script>
HTMLPurifier_AttrTransform_TargetBlank
Adds target="blank" to all outbound links. This transform is only attached if Attr.TargetBlank is TRUE. This works regardless of whether or not Attr.AllowedFrameTargets
HTMLPurifier_AttrTransform_TargetNoopener
Adds rel="noopener" to any links which target a different window than the current one. This is used to prevent malicious websites from silently replacing the original window, which could be used to do phishing.
HTMLPurifier_AttrTransform_TargetNoreferrer
Adds rel="noreferrer" to any links which target a different window than the current one. This is used to prevent malicious websites from silently replacing the original window, which could be used to do phishing.
HTMLPurifier_AttrTransform_Textarea
Sets height/width defaults for <textarea>
HTMLPurifier_AttrTransform
Processes an entire attribute array for corrections needing multiple values.
HTMLPurifier_AttrTypes
Provides lookup array of attribute types to HTMLPurifier_AttrDef objects
HTMLPurifier_AttrValidator
Validates the attributes of a token. Doesn't manage required attributes very well. The only reason we factored this out was because RemoveForeignElements also needed it besides ValidateAttributes.
HTMLPurifier_Bootstrap
Bootstrap class that contains meta-functionality for HTML Purifier such as the autoload function.
HTMLPurifier_ChildDef_Chameleon
Definition that uses different definitions depending on context.
HTMLPurifier_ChildDef_Custom
Custom validation class, accepts DTD child definitions
HTMLPurifier_ChildDef_Empty
Definition that disallows all elements.
HTMLPurifier_ChildDef_List
Definition for list containers ul and ol.
HTMLPurifier_ChildDef_Optional
Definition that allows a set of elements, and allows no children.
HTMLPurifier_ChildDef_Required
Definition that allows a set of elements, but disallows empty children.
HTMLPurifier_ChildDef_StrictBlockquote
Takes the contents of blockquote when in strict and reformats for validation.
HTMLPurifier_ChildDef_Table
Definition for tables. The general idea is to extract out all of the essential bits, and then reconstruct it later.
HTMLPurifier_ChildDef
Defines allowed child nodes and validates nodes against it.
HTMLPurifier_Config
Configuration object that triggers customizable behavior.
HTMLPurifier_ConfigSchema_Builder_ConfigSchema
Converts HTMLPurifier_ConfigSchema_Interchange to our runtime representation used to perform checks on user configuration.
HTMLPurifier_ConfigSchema_Builder_Xml
Converts HTMLPurifier_ConfigSchema_Interchange to an XML format, which can be further processed to generate documentation.
HTMLPurifier_ConfigSchema_Exception
Exceptions related to configuration schema
HTMLPurifier_ConfigSchema_Interchange_Directive
Interchange component class describing configuration directives.
HTMLPurifier_ConfigSchema_Interchange_Id
Represents a directive ID in the interchange format.
HTMLPurifier_ConfigSchema_Interchange
Generic schema interchange format that can be converted to a runtime representation (HTMLPurifier_ConfigSchema) or HTML documentation. Members are completely validated.
HTMLPurifier_ConfigSchema_InterchangeBuilder
HTMLPurifier_ConfigSchema_Validator
Performs validations on HTMLPurifier_ConfigSchema_Interchange
HTMLPurifier_ConfigSchema_ValidatorAtom
Fluent interface for validating the contents of member variables.
HTMLPurifier_ConfigSchema
Configuration definition, defines directives and their defaults.
HTMLPurifier_ContentSets
HTMLPurifier_Context
Registry object that contains information about the current context.
HTMLPurifier_CSSDefinition
Defines allowed CSS attributes and what their values are.
HTMLPurifier_Definition
Super-class for definition datatype objects, implements serialization functions for the class.
HTMLPurifier_DefinitionCache_Decorator_Cleanup
Definition cache decorator class that cleans up the cache whenever there is a cache miss.
HTMLPurifier_DefinitionCache_Decorator_Memory
Definition cache decorator class that saves all cache retrievals to PHP's memory; good for unit tests or circumstances where there are lots of configuration objects floating around.
HTMLPurifier_DefinitionCache_Decorator
Abstract class representing Definition cache managers that implements useful common methods and is a factory.
HTMLPurifier_DefinitionCache_Null
Null cache object to use when no caching is on.
HTMLPurifier_DefinitionCache_Serializer
Abstract class representing Definition cache managers that implements useful common methods and is a factory.
HTMLPurifier_DefinitionCache
Abstract class representing Definition cache managers that implements useful common methods and is a factory.
HTMLPurifier_DefinitionCacheFactory
Responsible for creating definition caches.
HTMLPurifier_Doctype
Represents a document type, contains information on which modules need to be loaded.
HTMLPurifier_DoctypeRegistry
HTMLPurifier_ElementDef
Structure that stores an HTML element definition. Used by HTMLPurifier_HTMLDefinition and HTMLPurifier_HTMLModule.
HTMLPurifier_Encoder
A UTF-8 specific character encoder that handles cleaning and transforming.
HTMLPurifier_EntityLookup
Object that provides entity lookup table from entity name to character
HTMLPurifier_EntityParser
Handles referencing and derefencing character entities
HTMLPurifier_ErrorCollector
Error collection class that enables HTML Purifier to report HTML problems back to the user
HTMLPurifier_ErrorStruct
Records errors for particular segments of an HTML document such as tokens, attributes or CSS properties. They can contain error structs (which apply to components of what they represent), but their main purpose is to hold errors applying to whatever struct is being used.
HTMLPurifier_Exception
Global exception class for HTML Purifier; any exceptions we throw are from here.
HTMLPurifier_Filter_ExtractStyleBlocks
This filter extracts <style> blocks from input HTML, cleans them up using CSSTidy, and then places them in $purifier->context->get('StyleBlocks') so they can be used elsewhere in the document.
HTMLPurifier_Filter_YouTube
Represents a pre or post processing filter on HTML Purifier's output
HTMLPurifier_Filter
Represents a pre or post processing filter on HTML Purifier's output
HTMLPurifier_Generator
Generates HTML from tokens.
HTMLPurifier_HTMLDefinition
Definition of the purified HTML that describes allowed children, attributes, and many other things.
HTMLPurifier_HTMLModule_Bdo
XHTML 1.1 Bi-directional Text Module, defines elements that declare directionality of content. Text Extension Module.
HTMLPurifier_HTMLModule_CommonAttributes
Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule_Edit
XHTML 1.1 Edit Module, defines editing-related elements. Text Extension Module.
HTMLPurifier_HTMLModule_Forms
XHTML 1.1 Forms module, defines all form-related elements found in HTML 4.
HTMLPurifier_HTMLModule_Hypertext
XHTML 1.1 Hypertext Module, defines hypertext links. Core Module.
HTMLPurifier_HTMLModule_Iframe
XHTML 1.1 Iframe Module provides inline frames.
HTMLPurifier_HTMLModule_Image
XHTML 1.1 Image Module provides basic image embedding.
HTMLPurifier_HTMLModule_Legacy
XHTML 1.1 Legacy module defines elements that were previously deprecated.
HTMLPurifier_HTMLModule_List
XHTML 1.1 List Module, defines list-oriented elements. Core Module.
HTMLPurifier_HTMLModule_Name
Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule_Nofollow
Module adds the nofollow attribute transformation to a tags. It is enabled by HTML.Nofollow
HTMLPurifier_HTMLModule_NonXMLCommonAttributes
Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule_Object
XHTML 1.1 Object Module, defines elements for generic object inclusion
HTMLPurifier_HTMLModule_Presentation
XHTML 1.1 Presentation Module, defines simple presentation-related markup. Text Extension Module.
HTMLPurifier_HTMLModule_Proprietary
Module defines proprietary tags and attributes in HTML.
HTMLPurifier_HTMLModule_Ruby
XHTML 1.1 Ruby Annotation Module, defines elements that indicate short runs of text alongside base text for annotation or pronounciation.
HTMLPurifier_HTMLModule_SafeEmbed
A "safe" embed module. See SafeObject. This is a proprietary element.
HTMLPurifier_HTMLModule_SafeObject
A "safe" object module. In theory, objects permitted by this module will be safe, and untrusted users can be allowed to embed arbitrary flash objects (maybe other types too, but only Flash is supported as of right now).
HTMLPurifier_HTMLModule_SafeScripting
A "safe" script module. No inline JS is allowed, and pointed to JS files must match whitelist.
HTMLPurifier_HTMLModule_Scripting
XHTML 1.1 Scripting module, defines elements that are used to contain information pertaining to executable scripts or the lack of support for executable scripts.
HTMLPurifier_HTMLModule_StyleAttribute
XHTML 1.1 Edit Module, defines editing-related elements. Text Extension Module.
HTMLPurifier_HTMLModule_Tables
XHTML 1.1 Tables Module, fully defines accessible table elements.
HTMLPurifier_HTMLModule_Target
XHTML 1.1 Target Module, defines target attribute in link elements.
HTMLPurifier_HTMLModule_TargetBlank
Module adds the target=blank attribute transformation to a tags. It is enabled by HTML.TargetBlank
HTMLPurifier_HTMLModule_TargetNoopener
Module adds the target-based noopener attribute transformation to a tags. It is enabled by HTML.TargetNoopener
HTMLPurifier_HTMLModule_TargetNoreferrer
Module adds the target-based noreferrer attribute transformation to a tags. It is enabled by HTML.TargetNoreferrer
HTMLPurifier_HTMLModule_Text
XHTML 1.1 Text Module, defines basic text containers. Core Module.
HTMLPurifier_HTMLModule_Tidy_Name
Name is deprecated, but allowed in strict doctypes, so onl
HTMLPurifier_HTMLModule_Tidy_Proprietary
Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_Strict
Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_Transitional
Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_XHTML
Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_XHTMLAndHTML4
Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy
Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_XMLCommonAttributes
Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule
Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModuleManager
HTMLPurifier_IDAccumulator
Component of HTMLPurifier_AttrContext that accumulates IDs to prevent dupes
HTMLPurifier_Injector_AutoParagraph
Injector that auto paragraphs text in the root node based on double-spacing.
HTMLPurifier_Injector_DisplayLinkURI
Injector that displays the URL of an anchor instead of linking to it, in addition to showing the text of the link.
HTMLPurifier_Injector_Linkify
Injector that converts http, https and ftp text URLs to actual links.
HTMLPurifier_Injector_PurifierLinkify
Injector that converts configuration directive syntax %Namespace.Directive to links
HTMLPurifier_Injector_RemoveEmpty
Injects tokens into the document while parsing for well-formedness.
HTMLPurifier_Injector_RemoveSpansWithoutAttributes
Injector that removes spans with no attributes
HTMLPurifier_Injector_SafeObject
Adds important param elements to inside of object in order to make things safe.
HTMLPurifier_Injector
Injects tokens into the document while parsing for well-formedness.
HTMLPurifier_Language
Represents a language and defines localizable string formatting and other functions, as well as the localized messages for HTML Purifier.
HTMLPurifier_LanguageFactory
Class responsible for generating HTMLPurifier_Language objects, managing caching and fallbacks.
HTMLPurifier_Length
Represents a measurable length, with a string numeric magnitude and a unit. This object is immutable.
HTMLPurifier_Lexer_DirectLex
Our in-house implementation of a parser.
HTMLPurifier_Lexer_DOMLex
Parser that uses PHP 5's DOM extension (part of the core).
HTMLPurifier_Lexer_PH5P
Experimental HTML5-based parser using Jeroen van der Meer's PH5P library.
HTML5
HTML5TreeConstructer
HTMLPurifier_Lexer
Forgivingly lexes HTML (SGML-style) markup into tokens.
HTMLPurifier_Node_Comment
Concrete comment node class.
HTMLPurifier_Node_Element
Concrete element node class.
HTMLPurifier_Node_Text
Concrete text token class.
HTMLPurifier_Node
Abstract base node class that all others inherit from.
HTMLPurifier_PercentEncoder
Class that handles operations involving percent-encoding in URIs.
HTMLPurifier_Printer_ConfigForm
HTMLPurifier_Printer_ConfigForm_NullDecorator
Printer decorator for directives that accept null
HTMLPurifier_Printer_ConfigForm_default
Swiss-army knife configuration form field printer
HTMLPurifier_Printer_ConfigForm_bool
Bool form field printer
HTMLPurifier_Printer_CSSDefinition
HTMLPurifier_Printer_HTMLDefinition
HTMLPurifier_Printer
HTMLPurifier_PropertyList
Generic property list implementation
HTMLPurifier_PropertyListIterator
Property list iterator. Do not instantiate this class directly.
HTMLPurifier_Queue
A simple array-backed queue, based off of the classic Okasaki persistent amortized queue. The basic idea is to maintain two stacks: an input stack and an output stack. When the output stack runs out, reverse the input stack and use it as the output stack.
HTMLPurifier_Strategy_Composite
Composite strategy that runs multiple strategies on tokens.
HTMLPurifier_Strategy_Core
Core strategy composed of the big four strategies.
HTMLPurifier_Strategy_FixNesting
Takes a well formed list of tokens and fixes their nesting.
HTMLPurifier_Strategy_MakeWellFormed
Takes tokens makes them well-formed (balance end tags, etc.)
HTMLPurifier_Strategy_RemoveForeignElements
Removes all unrecognized tags from the list of tokens.
HTMLPurifier_Strategy_ValidateAttributes
Validate all attributes in the tokens.
HTMLPurifier_Strategy
Supertype for classes that define a strategy for modifying/purifying tokens.
HTMLPurifier_StringHash
This is in almost every respect equivalent to an array except that it keeps track of which keys were accessed.
HTMLPurifier_StringHashParser
Parses string hash files. File format is as such:
HTMLPurifier_TagTransform_Font
Transforms FONT tags to the proper form (SPAN with CSS styling)
HTMLPurifier_TagTransform_Simple
Simple transformation, just change tag name to something else, and possibly add some styling. This will cover most of the deprecated tag cases.
HTMLPurifier_TagTransform
Defines a mutation of an obsolete tag into a valid tag.
HTMLPurifier_Token_Comment
Concrete comment token class. Generally will be ignored.
HTMLPurifier_Token_Empty
Concrete empty token class.
HTMLPurifier_Token_End
Concrete end token class.
HTMLPurifier_Token_Start
Concrete start token class.
HTMLPurifier_Token_Tag
Abstract class of a tag token (start, end or empty), and its behavior.
HTMLPurifier_Token_Text
Concrete text token class.
HTMLPurifier_Token
Abstract base token class that all others inherit from.
HTMLPurifier_TokenFactory
Factory for token generation.
HTMLPurifier_UnitConverter
Class for converting between different unit-lengths as specified by CSS.
HTMLPurifier_URI
HTML Purifier's internal representation of a URI.
HTMLPurifier_URIDefinition
Super-class for definition datatype objects, implements serialization functions for the class.
HTMLPurifier_URIFilter_DisableExternal
Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_DisableExternalResources
Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_DisableResources
Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_HostBlacklist
Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_MakeAbsolute
Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_Munge
Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_SafeIframe
Implements safety checks for safe iframes.
HTMLPurifier_URIFilter
Chainable filters for custom URI processing.
HTMLPurifier_URIParser
Parses a URI into the components and fragment identifier as specified by RFC 3986.
HTMLPurifier_URIScheme_data
Implements data: URI for base64 encoded images supported by GD.
HTMLPurifier_URIScheme_file
Validates file as defined by RFC 1630 and RFC 1738.
HTMLPurifier_URIScheme_ftp
Validates ftp (File Transfer Protocol) URIs as defined by generic RFC 1738.
HTMLPurifier_URIScheme_http
Validates http (HyperText Transfer Protocol) as defined by RFC 2616
HTMLPurifier_URIScheme_https
Validates https (Secure HTTP) according to http scheme.
HTMLPurifier_URIScheme_mailto
Validates mailto (for E-mail) according to RFC 2368
HTMLPurifier_URIScheme_news
Validates news (Usenet) as defined by generic RFC 1738
HTMLPurifier_URIScheme_nntp
Validates nntp (Network News Transfer Protocol) as defined by generic RFC 1738
HTMLPurifier_URIScheme_tel
Validates tel (for phone numbers).
HTMLPurifier_URIScheme
Validator for the components of a URI for a specific scheme
HTMLPurifier_URISchemeRegistry
Registry for retrieving specific URI scheme validator objects.
HTMLPurifier_VarParser_Flexible
Performs safe variable parsing based on types which can be used by users. This may not be able to represent all possible data inputs, however.
HTMLPurifier_VarParser_Native
This variable parser uses PHP's internal code engine. Because it does this, it can represent all inputs; however, it is dangerous and cannot be used by users.
HTMLPurifier_VarParser
Parses string representations into their corresponding native PHP variable type. The base implementation does a simple type-check.
HTMLPurifier_VarParserException
Exception type for HTMLPurifier_VarParser
HTMLPurifier_Zipper
A zipper is a purely-functional data structure which contains a focus that can be efficiently manipulated. It is known as a "one-hole context". This mutable variant implements a zipper for a list as a pair of two arrays, laid out as follows:
HTMLPurifier
Facade that coordinates HTML Purifier's subsystems in order to purify HTML.
Ean
Utility class for validating EAN-8 and EAN-13 numbers
Iban
Inn
Isbn
Utility class for validating ISBN-10
Luhn
Utility class for generating and validating Luhn numbers.
TCNo
ChanceGenerator
This generator returns a default value for all called properties and methods. It works with Faker\Generator::optional().
Container
A simple implementation of a container.
ContainerBuilder
ContainerException
NotInContainerException
Barcode
Blood
Color
Coordinates
DateTime
File
Number
Uuid
Version
DefaultGenerator
This generator returns a default value for all called properties and methods.
Documentor
ExtensionNotFound
Helper
A class with some methods that may make building extensions easier.
Factory
Generator
Name
ColumnTypeGuesser
EntityPopulator
Populator
ColumnTypeGuesser
EntityPopulator
Service class for populating a table through a Doctrine Entity class.
Populator
Service class for populating a database using the Doctrine ORM or ODM.
ColumnTypeGuesser
EntityPopulator
Service class for populating a table through a Mandango ActiveRecord class.
Populator
Service class for populating a database using Mandango.
ColumnTypeGuesser
EntityPopulator
Service class for populating a table through a Propel ActiveRecord class.
Populator
Service class for populating a database using the Propel ORM.
ColumnTypeGuesser
EntityPopulator
Service class for populating a table through a Propel ActiveRecord class.
Populator
Service class for populating a database using the Propel ORM.
ColumnTypeGuesser
EntityPopulator
Service class for populating a table through a Spot Entity class.
Populator
Service class for populating a database using the Spot ORM.
Address
Address
Color
Company
Internet
Payment
Person
Text
Address
Company
Internet
Person
Text
Address
Color
Company
Internet
Payment
Person
Text
Payment
Barcode
Base
Internet
Payment
Person
PhoneNumber
Biased
Address
Company
Person
PhoneNumber
Utils
Color
Company
Address
Company
DateTime
Czech months and days without setting locale
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
DateTime
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Company
Payment
Person
PhoneNumber
Text
Address
Internet
PhoneNumber
Address
Extend US class since most fields share the same format
PhoneNumber
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Internet
PhoneNumber
Address
Internet
Person
PhoneNumber
Address
Internet
Person
PhoneNumber
Address
Internet
PhoneNumber
Address
PhoneNumber
Address
Person
PhoneNumber
Address
Internet
Person
PhoneNumber
Address
Company
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Person
PhoneNumber
Address
Company
Person
PhoneNumber
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Person
PhoneNumber
Address
Company
Internet
Person
PhoneNumber
Person
Address
Company
Internet
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
File
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Address
Color
Company
Person
Text
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Payment
Person
PhoneNumber
Address
Company
Payment
Person
PhoneNumber
HtmlLorem
Address
Company
Payment
Person
More info about the hungarian names and hungarian name abbreviations can be found here:
PhoneNumber
Text
Address
Color
Company
Internet
Person
PhoneNumber
Address
Color
Company
Internet
Person
PhoneNumber
Image
Depends on image generation from http://lorempixel.com/
Internet
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Person
PhoneNumber
Text
Address
Color
Company
DateTime
Internet
Payment
Person
PhoneNumber
Text
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Person
PhoneNumber
Text
Lorem
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Color
Internet
Payment
Person
PhoneNumber
Address
Company
Payment
Person
PhoneNumber
Medical
Miscellaneous
Person
PhoneNumber
Address
Company
Miscellaneous
Payment
Person
PhoneNumber
Address
Company
Payment
Person
PhoneNumber
Address
Internet
Payment
Person
PhoneNumber
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
Payment
Person
PhoneNumber
Address
Color
Company
Internet
LicensePlate
Generator of Polish vehicle registration numbers.
Payment
Person
Most popular first and last names published by Ministry of the Interior:
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Payment
Person
PhoneNumber
Text
Address
Payment
Person
PhoneNumber
Text
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Payment
Person
Address
Payment
Person
Address
Payment
Person
Address
Company
Municipality
Payment
Person
PhoneNumber
Text
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Address
Color
Company
DateTime
Internet
Payment
Person
PhoneNumber
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
UserAgent
Uuid
Address
Color
Internet
Person
PhoneNumber
Address
Color
Company
DateTime
Internet
Payment
Person
PhoneNumber
Address
Color
Company
DateTime
Internet
Payment
Person
PhoneNumber
Text
UniqueGenerator
Proxy for other generators that returns only unique values.
ValidGenerator
Proxy for other generators, to return only valid values. Works with Faker\Generator\Base->valid()
ErrorException
Wraps ErrorException; mostly used for typing (at least now) to easily cleanup the stack trace of redundant info.
Formatter
Frame
FrameCollection
Exposes a fluent interface for dealing with an ordered list of stack-trace frames.
Inspector
CallbackHandler
Wrapper for Closures passed as handlers. Can be used directly, or will be instantiated automagically by Whoops\Run if passed to Run::pushHandler
Handler
Abstract implementation of a Handler.
JsonResponseHandler
Catches an exception and converts it to a JSON response. Additionally can also return exception frames for consumption by an API.
PlainTextHandler
Handler outputing plaintext error messages. Can be used directly, or will be instantiated automagically by Whoops\Run if passed to Run::pushHandler
PrettyPageHandler
Abstract implementation of a Handler.
XmlResponseHandler
Catches an exception and converts it to an XML response. Additionally can also return exception frames for consumption by an API.
InspectorFactory
Run
HtmlDumperOutput
Used as output callable for Symfony\Component\VarDumper\Dumper\HtmlDumper::dump()
Misc
SystemFacade
TemplateHelper
Exposes useful tools for working with/in templates
BeforeValidException
CachedKeySet
ExpiredException
Key
SignatureInvalidException
CorsService
InvalidOptionException
AccessToken
Wrapper around Google Access Tokens which provides convenience functions.
ApplicationDefaultCredentials
ApplicationDefaultCredentials obtains the default credentials for authorizing a request to a Google service.
FileSystemCacheItemPool
InvalidArgumentException
Item
A cache item.
MemoryCacheItemPool
Simple in-memory cache implementation.
SysVCacheItemPool
SystemV shared memory based CacheItemPool implementation.
TypedItem
A cache item.
AppIdentityCredentials
CredentialsLoader contains the behaviour used to locate and find default credentials files on the file system.
ExternalAccountCredentials
GCECredentials
GCECredentials supports authorization on Google Compute Engine.
IAMCredentials
Authenticates requests using IAM credentials.
ImpersonatedServiceAccountCredentials
CredentialsLoader contains the behaviour used to locate and find default credentials files on the file system.
InsecureCredentials
Provides a set of credentials that will always return an empty access token.
ServiceAccountCredentials
ServiceAccountCredentials supports authorization using a Google service account.
ServiceAccountJwtAccessCredentials
Authenticates requests using Google's Service Account credentials via JWT Access.
UserRefreshCredentials
Authenticates requests using User Refresh credentials.
CredentialsLoader
CredentialsLoader contains the behaviour used to locate and find default credentials files on the file system.
AwsNativeSource
Authenticates requests using AWS credentials.
ExecutableSource
ExecutableSource enables the exchange of workload identity pool external credentials for Google access tokens by retrieving 3rd party tokens through a user supplied executable. These scripts/executables are completely independent of the Google Cloud Auth libraries. These credentials plug into ADC and will call the specified executable to retrieve the 3rd party token to be exchanged for a Google access token.
FileSource
Retrieve a token from a file.
UrlSource
Retrieve a token from a URL.
ExecutableHandler
ExecutableResponseError
FetchAuthTokenCache
A class to implement caching for any object implementing FetchAuthTokenInterface
GCECache
A class to implement caching for calls to GCECredentials::onGce. This class is used automatically when you pass a `Psr\Cache\CacheItemPoolInterface` cache object to `ApplicationDefaultCredentials::getCredentials`.
Guzzle6HttpHandler
Guzzle7HttpHandler
HttpClientCache
Stores an HTTP Client in order to prevent multiple instantiations.
HttpHandlerFactory
Iam
Tools for using the IAM API.
AuthTokenMiddleware
AuthTokenMiddleware is a Guzzle Middleware that adds an Authorization header provided by an object implementing FetchAuthTokenInterface.
ProxyAuthTokenMiddleware
ProxyAuthTokenMiddleware is a Guzzle Middleware that adds an Authorization header provided by an object implementing FetchAuthTokenInterface.
ScopedAccessTokenMiddleware
ScopedAccessTokenMiddleware is a Guzzle Middleware that adds an Authorization header provided by a closure.
SimpleMiddleware
SimpleMiddleware is a Guzzle Middleware that implements Google's Simple API access.
OAuth2
OAuth2 supports authentication by OAuth2 2-legged flows.
AnonymousCredentials
Provides an anonymous set of credentials, which is useful for APIs which do not require authentication.
BatchDaemon
An external daemon script for executing the batch jobs.
BatchJob
Represent batch jobs.
BatchRunner
A class for executing jobs in batch.
InMemoryConfigStorage
In-memory ConfigStorageInterface implementation.
JobConfig
Hold configurations for the {@see \Google\Cloud\Core\Batch\BatchRunner}.
OpisClosureSerializer
A closure serializer utilizing [Opis Closure Library](https://github.com/opis/closure).
QueueOverflowException
Exception thrown in {@see \Google\Cloud\Core\Batch\SysvProcessor::submit()} method when it cannot add an item to the message queue.
Retry
A class for retrying the failed items.
SimpleJob
Represents a simple job that runs a single method that loops forever.
SysvConfigStorage
ConfigStorageInterface implementation with SystemV IPC shared memory.
SysvProcessor
ProcessItemInterface implementation with SysV IPC message queue.
Blob
Represents a Blob value.
HttpHandlerReader
Read Compute Metadata using the HTTP Handler utility.
StreamReader
A class only reading the metadata URL with an appropriate header.
Metadata
A library for accessing the Google Compute Engine (GCE) metadata.
Duration
Represents a Duration type.
AbortedException
Exception thrown when a transaction is aborted.
BadRequestException
Exception thrown when a request fails due to an error in the request.
ConflictException
Exception thrown when a request fails due to a conflict.
DeadlineExceededException
Exception thrown when a request takes too long to complete.
FailedPreconditionException
Exception thrown when a request fails due to a failed precondition.
GoogleException
Exception thrown when a request fails.
NotFoundException
Exception thrown when a resource is not found.
ServerException
Exception thrown when a request fails due to an error on the server.
ServiceException
Exception thrown when a request fails.
ExponentialBackoff
Exponential backoff implementation.
GeoPoint
Represents a geographical point.
GrpcRequestWrapper
The GrpcRequestWrapper is responsible for delivering gRPC requests.
Iam
IAM Manager
PolicyBuilder
Helper class for creating valid IAM policies
InsecureCredentialsWrapper
For connect to emulator.
Int64
Represents a 64 bit integer. This can be useful when working on a 32 bit platform.
ItemIterator
Iterates over a set of items.
PageIterator
Iterates over a set of pages.
FlockLock
Flock based lock implementation.
SemaphoreLock
Semaphore based lock implementation.
SymfonyLockAdapter
Symfony lock component adapter.
AppEngineFlexFormatter
Monolog 1.x formatter for formatting logs on App Engine flexible environment.
AppEngineFlexFormatterV2
Monolog 2.x formatter for formatting logs on App Engine flexible environment.
AppEngineFlexFormatterV3
Monolog 3.x formatter for formatting logs on App Engine flexible environment.
AppEngineFlexHandlerFactory
Factory to build out an AppEngineFlexHandler for the installed version of Monolog.
LongRunningOperation
Represent and interact with a Long Running Operation.
CloudRunJobMetadataProvider
A MetadataProvider for Cloud Run Jobs.
CloudRunMetadataProvider
A MetadataProvider for Cloud Run Services.
CloudRunServiceMetadataProvider
A MetadataProvider for Cloud Run Services.
EmptyMetadataProvider
An empty MetadataProvider.
GAEFlexMetadataProvider
An MetadataProvider for GAE Flex.
GAEMetadataProvider
MetadataProvider for GAE.
GAEStandardMetadataProvider
An MetadataProvider for GAE Standard.
MetadataProviderUtils
Utility class for MetadataProvider.
SimpleMetadataProvider
Simple MetadataProvider.
RequestBuilder
Builds a PSR7 request from a service definition.
RequestWrapper
The RequestWrapper is responsible for delivering and signing requests.
Retry
Retry implementation.
ServiceBuilder
Google Cloud Platform is a set of modular cloud-based services that allow you to create anything from simple websites to complex applications.
RegexFileFilter
A regex exclude path
InvokeResult
Class InvokeResult
Parser
A class for parsing code snippets from a class and its methods.
Snippet
Represents a single code snippet
KeyManager
Manage KMS keys used for system tests.
Timestamp
Represents a Timestamp value.
AbstractUploader
Provides a base impementation for uploads.
MultipartUploader
Multipart upload implementation.
ResumableUploader
Resumable upload implementation.
SignedUrlUploader
Upload data to Cloud Storage using a Signed URL
StreamableUploader
Uploader that is a special case of the ResumableUploader where we can write the file contents in a streaming manner.
Acl
Google Cloud Storage uses access control lists (ACLs) to manage bucket and object access. ACLs are the mechanism you use to share objects with other users and allow other users to access your buckets and objects. For more information please see the overview on [access-control](https://cloud.google.com/storage/docs/access-control).
Bucket
Buckets are the basic containers that hold your data. Everything that you store in Google Cloud Storage must be contained in a bucket.
CreatedHmacKey
Represents a newly created HMAC key. Provides access to the key metadata and secret.
HmacKey
Represents a Service Account HMAC key.
Lifecycle
Object Lifecycle Management supports common use cases like setting a Time to Live (TTL) for objects, archiving older versions of objects, or "downgrading" storage classes of objects to help manage costs.
Notification
Cloud Pub/Sub Notifications sends information about changes to objects in your buckets to Google Cloud Pub/Sub, where the information is added to a Cloud Pub/Sub topic of your choice in the form of messages. For example, you can track objects that are created and deleted in your bucket. Each notification contains information describing both the event that triggered it and the object that changed.
ObjectIterator
ObjectIterator
ObjectPageIterator
ObjectPageIterator
ReadStream
A Stream implementation that wraps a GuzzleHttp download stream to provide `getSize()` from the response headers.
StorageClient
Google Cloud Storage allows you to store and retrieve data on Google's infrastructure. Find more information at the [Google Cloud Storage API docs](https://developers.google.com/storage).
StorageObject
Objects are the individual pieces of data that you store in Google Cloud Storage.
StreamWrapper
A streamWrapper implementation for handling `gs://bucket/path/to/file.jpg`.
WriteStream
A Stream implementation that uploads in chunks to a provided uploader when we reach a certain chunkSize. Upon `close`, we will upload the remaining chunk.
Advice
Generated advice about this change, used for providing more information about how a change will affect the existing service.
Authentication
`Authentication` defines the authentication configuration for API methods provided by an API service.
AuthenticationRule
Authentication rules for the service.
AuthProvider
Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
AuthRequirement
User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
Backend
`Backend` defines the backend configuration for a service.
PathTranslation
Path Translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request.
BackendRule
A backend rule provides configuration for an individual API element.
BillingDestination
Configuration of a specific billing destination (Currently only support bill against consumer project).
Billing
Billing related configuration of the service.
ChangeType
Classifies set of possible modifications to an object in the service configuration.
ClientLibraryDestination
To where should client libraries be published?
ClientLibraryOrganization
The organization for which the client libraries are being published.
ClientLibrarySettings
Details about how and where to publish client libraries.
CommonLanguageSettings
Required information for every language.
ConfigChange
Output generated from semantically comparing two versions of a service configuration.
Context
`Context` defines which contexts an API requests.
ContextRule
A context rule provides information about the context for an individual API element.
Control
Selects and configures the service controller used by the service.
CppSettings
Settings for C++ client libraries.
CustomHttpPattern
A custom pattern is used for defining custom HTTP verb.
Explicit
Specifies a set of buckets with arbitrary widths.
Exponential
Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.
Linear
Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.
BucketOptions
`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly.
Exemplar
Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
Range
The range of the population values.
Distribution
`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.
Documentation
`Documentation` provides the information for describing a service.
DocumentationRule
A documentation rule provides information about individual API elements.
DotnetSettings
Settings for Dotnet client libraries.
Endpoint
`Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics.
ErrorReason
Defines the supported values for `google.rpc.ErrorInfo.reason` for the `googleapis.com` error domain. This error domain is reserved for [Service Infrastructure](https://cloud.google.com/service-infrastructure/docs/overview).
FieldBehavior
An indicator of the behavior of a given field (for example, that a field is required in requests, or given as output but ignored as input).
Format
The standard format of a field value. The supported formats are all backed by either an RFC defined by the IETF or a Google-defined AIP.
FieldInfo
Rich semantic information of an API field beyond basic typing.
FieldPolicy
Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies.
GoSettings
Settings for Go client libraries.
Http
Defines the HTTP configuration for an API service. It contains a list of [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method to one or more HTTP REST API methods.
HttpBody
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.
HttpRule
gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services.
JavaSettings
Settings for Java client libraries.
JwtLocation
Specifies a location to extract JWT from an API request.
ValueType
Value types that can be used as label values.
LabelDescriptor
A description of a label.
LaunchStage
The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages).
LogDescriptor
A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items.
LoggingDestination
Configuration of a specific logging destination (the producer project or the consumer project).
Logging
Logging configuration of the service.
MethodPolicy
Defines policies applying to an RPC method.
LongRunning
Describes settings to use when generating API methods that use the long-running operation pattern.
MethodSettings
Describes the generator configuration for a method.
Metric
A specific metric, identified by specifying values for all of the labels of a [`MetricDescriptor`][google.api.MetricDescriptor].
TimeSeriesResourceHierarchyLevel
The resource hierarchy level of the timeseries data of a metric.
MetricDescriptorMetadata
Additional annotations that can be used to guide the usage of a metric.
MetricKind
The kind of measurement. It describes how the data is reported.
ValueType
The value type of a metric.
MetricDescriptor
Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
MetricRule
Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.
MonitoredResource
An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema.
MonitoredResourceDescriptor
An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances.
MonitoredResourceMetadata
Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource] object. [MonitoredResource][google.api.MonitoredResource] objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.
MonitoringDestination
Configuration of a specific monitoring destination (the producer project or the consumer project).
Monitoring
Monitoring configuration of the service.
NodeSettings
Settings for Node client libraries.
OAuthRequirements
OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf.
Page
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
PhpSettings
Settings for Php client libraries.
ProjectProperties
A descriptor for defining project properties for a service. One service may have many consumer projects, and the service may want to behave differently depending on some properties on the project. For example, a project may be associated with a school, or a business, or a government agency, a business type property on the project may affect how a service responds to the client.
PropertyType
Supported data type of the property values
Property
Defines project properties.
Publishing
This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config.
ExperimentalFeatures
Experimental features to be included during client library generation.
PythonSettings
Settings for Python client libraries.
Quota
Quota configuration helps to achieve fairness and budgeting in service usage.
QuotaLimit
`QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`.
History
A description of the historical or future-looking state of the resource pattern.
Style
A flag representing a specific style that a resource claims to conform to.
ResourceDescriptor
A simple descriptor of a resource type.
ResourceReference
Defines a proto annotation that describes a string field that refers to an API resource.
RoutingParameter
A projection from an input message to the GRPC or REST header.
RoutingRule
Specifies the routing information that should be sent along with the request in the form of routing header.
RubySettings
Settings for Ruby client libraries.
SelectiveGapicGeneration
This message is used to configure the generation of a subset of the RPCs in a service for client libraries.
Service
`Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth.
SourceInfo
Source information used to create a Service Config
SystemParameter
Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.
SystemParameterRule
Define a system parameter rule mapping system parameter definitions to methods.
SystemParameters
### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.
TypeReference
A reference to a message type, for use in [FieldInfo][google.api.FieldInfo].
Usage
Configuration controlling usage of a service.
UsageRule
Usage configuration rules for the service.
Visibility
`Visibility` restricts service consumer's access to service elements, such as whether an application can call a visibility-restricted method.
VisibilityRule
A visibility rule provides visibility configuration for an individual API element.
AuditConfig
Specifies the audit configuration for a service.
Action
The type of action performed on an audit configuration in a policy.
AuditConfigDelta
One delta entry for AuditConfig. Each individual change (only one exempted_member in each entry) to a AuditConfig will be a separate entry.
LogType
The list of valid permission types for which logging can be configured.
AuditLogConfig
Provides the configuration for logging a type of permissions.
Binding
Associates `members`, or principals, with a `role`.
Action
The type of action performed on a Binding in a policy.
BindingDelta
One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.
GetIamPolicyRequest
Request message for `GetIamPolicy` method.
GetPolicyOptions
Encapsulates settings provided to GetIamPolicy.
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
PolicyDelta
The difference delta between two policies.
ResourcePolicyMember
Output-only policy member strings of a Google Cloud resource's built-in identity.
SetIamPolicyRequest
Request message for `SetIamPolicy` method.
TestIamPermissionsRequest
Request message for `TestIamPermissions` method.
TestIamPermissionsResponse
Response message for `TestIamPermissions` method.
GetLocationRequest
The request message for [Locations.GetLocation][google.cloud.location.Locations.GetLocation].
ListLocationsRequest
The request message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
ListLocationsResponse
The response message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
Location
A resource that represents Google Cloud Platform location.
HttpRequest
A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.
LogSeverity
The severity of the event described in a log entry, expressed as one of the standard severity levels listed below. For your reference, the levels are assigned the listed numeric values. The effect of using numeric values other than those listed is undefined.
OperationResponseMapping
An enum to be used to mark the essential (for polling) fields in an API-specific Operation object. A custom Operation object may contain many different fields, but only few of them are essential to conduct a successful polling process.
AuditData
Audit log information specific to Cloud IAM. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message.
FieldViolation
A message type used to describe a single bad request field.
BadRequest
Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
Code
The canonical error codes for gRPC APIs.
Api
This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI.
Auth
This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards.
Peer
This message defines attributes for a node that handles a network request.
Request
This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.
Resource
This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service.
Response
This message defines attributes for a typical network response. It generally models semantics of an HTTP response.
AttributeContext
This message defines the standard attribute vocabulary for Google APIs.
AuditContext
`AuditContext` provides information that is needed for audit logging.
DebugInfo
Describes additional debugging info.
ErrorInfo
Describes the cause of the error with structured details.
Link
Describes a URL link.
Help
Provides links to documentation or for performing an out of band action.
LocalizedMessage
Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
Violation
A message type used to describe a single precondition failure.
PreconditionFailure
Describes what preconditions have failed.
Violation
A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
QuotaFailure
Describes how a quota check failed.
RequestInfo
Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
ResourceInfo
Describes the resource that is being accessed.
RetryInfo
Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.
Status
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.
CalendarPeriod
A `CalendarPeriod` represents the abstract concept of a time period that has a canonical start. Grammatically, "the start of the current `CalendarPeriod`." All calendar times begin at midnight UTC.
Color
Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript.
Date
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.
DateTime
Represents civil time (or occasionally physical time).
DayOfWeek
Represents a day of the week.
Decimal
A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][].
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.
Fraction
Represents a fraction in terms of a numerator divided by a denominator.
Interval
Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).
LatLng
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges.
LocalizedText
Localized variant of a text in a particular language.
Money
Represents an amount of money with its currency type.
Month
Represents a month in the Gregorian calendar.
ShortCode
An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan.").
PhoneNumber
An object representing a phone number, suitable as an API wire format.
PostalAddress
Represents a postal address, e.g. for postal delivery or payments addresses.
Quaternion
A quaternion is defined as the quotient of two directed lines in a three-dimensional space or equivalently as the quotient of two Euclidean vectors (https://en.wikipedia.org/wiki/Quaternion).
TimeOfDay
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`.
TimeZone
Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).
Example
AgentHeader
Class containing functions used to build the Agent header.
ApiException
Represents an exception thrown during an RPC.
ApiKeyHeaderCredentials
The ApiKeyHeaderCredentials object provides a wrapper around an API key.
ApiStatus
BidiStream
BidiStream is the response object from a gRPC bidirectional streaming API call.
Call
Contains information necessary to manage a network request.
ClientStream
ClientStream is the response object from a gRPC client streaming API call.
CredentialsWrapper
The CredentialsWrapper object provides a wrapper around a FetchAuthTokenInterface.
FixedSizeCollection
A collection of elements retrieved using one or more API calls. The collection will attempt to retrieve a fixed number of elements, and will make API calls until that fixed number is reached, or there are no more elements to retrieve.
GPBLabel
Container class for Protobuf label constants. See FieldDescriptorProto.Label in https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
GPBType
Container class for Protobuf type constants. See FieldDescriptorProto.Type in https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
InsecureCredentialsWrapper
For connect to emulator.
CredentialsWrapperMiddleware
Middleware which adds a CredentialsWrapper object to the call options.
FixedHeaderMiddleware
Middleware to add fixed headers to an API call.
OperationsMiddleware
Middleware which wraps the response in an OperationResponse object.
OptionsFilterMiddleware
Middleware which filters the $options array.
PagedMiddleware
Middleware which wraps the response in an PagedListResponses object.
ResponseMetadataMiddleware
Middleware which transforms $response into [$response, $metadata]
RetryMiddleware
Middleware that adds retry functionality.
OperationResponse
Response object from a long running API method.
CallOptions
The CallOptions class provides typing to the associative array of options passed to transport RPC methods. See {@see \Google\ApiCore\Transport\TransportInterface::startUnaryCall()}, {@see \Google\ApiCore\Transport\TransportInterface::startBidiStreamingCall()}, {@see \Google\ApiCore\Transport\TransportInterface::startClientStreamingCall()}, and {@see \Google\ApiCore\Transport\TransportInterface::startServerStreamingCall()}.
ClientOptions
The ClientOptions class adds typing to the associative array of options passed into each API client constructor. To use this class directly, pass the result of {@see \Google\ApiCore\Options\ClientOptions::toArray()} to the client constructor:
GrpcFallbackTransportOptions
The GrpcFallbackTransportOptions class provides typing to the associative array of options used to configure {@see \Google\ApiCore\Transport\GrpcFallbackTransport}.
GrpcTransportOptions
The GrpcTransportOptions class provides typing to the associative array of options used to configure {@see \Google\ApiCore\Transport\GrpcTransport}.
RestTransportOptions
The RestTransportOptions class provides typing to the associative array of options used to configure {@see \Google\ApiCore\Transport\RestTransport}.
TransportOptions
Page
A Page object wraps an API list method response and provides methods to retrieve additional pages using the page token.
PagedListResponse
Response object for paged results from a list API method
PageStreamingDescriptor
Holds the description information used for page streaming.
PathTemplate
Represents a path template.
RequestParamsHeaderDescriptor
Encapsulates request params header metadata.
RetrySettings
The RetrySettings class is used to configure retrying and timeouts for RPCs.
Serializer
Collection of methods to help with serialization of protobuf objects
ServerStream
ServerStream is the response object from a server streaming API call.
ForwardingCall
Class ForwardingCall wraps a \Grpc\AbstractCall.
ForwardingServerStreamingCall
Class ForwardingServerStreamingCall wraps a \Grpc\ServerStreamingCall.
ForwardingUnaryCall
Class ForwardingUnaryCall wraps a \Grpc\UnaryCall.
ServerStreamingCallWrapper
Class ServerStreamingCallWrapper implements \Google\ApiCore\ServerStreamingCallInterface.
GrpcFallbackTransport
A transport that sends protobuf over HTTP 1.1 that can be used when full gRPC support is not available.
GrpcTransport
A gRPC based transport implementation.
JsonStreamDecoder
RestServerStreamingCall
Class RestServerStreamingCall implements \Google\ApiCore\ServerStreamingCallInterface.
RestTransport
A REST based transport implementation.
ValidationException
ValidationException represents a local error (i.e. not during an RPC call).
StackdriverUtil
ChannelRef
ChannelRef is used to record how many active streams the channel has.
Config
Config is used to enable the support for the channel management.
CreatedByDeserializeCheck
DeserializeCheck is used to check whether _ChannelRef is created by deserialization or not.
GcpBaseCall
GCPBidiStreamingCall
Represents an active call that allows for sending and recieving messages in streams in any order.
GCPCallInvoker
GCPCallInvoker updates the channel pool(GcpExtensionChannel) for each RPC. The idea is: Before the RPC starts, pick a channel from the channel pool: - if the RPC is bound to a channel, use that channel.
GCPClientStreamCall
Represents an active call that sends a stream of messages and then gets a single response.
GcpExtensionChannel
GcpExtensionChannel maintains an array of channels for certain API.
GCPServerStreamCall
Represents an active call that sends a single message and then gets a stream of responses.
GCPUnaryCall
Represents an active call that sends a single message and then gets a single response.
GrpcGcp
AffinityConfig
Generated from protobuf message <code>grpc.gcp.AffinityConfig</code>
AffinityConfig_Command
Protobuf enum <code>Grpc\Gcp\AffinityConfig\Command</code>
ApiConfig
Generated from protobuf message <code>grpc.gcp.ApiConfig</code>
ChannelPoolConfig
Generated from protobuf message <code>grpc.gcp.ChannelPoolConfig</code>
MethodConfig
Generated from protobuf message <code>grpc.gcp.MethodConfig</code>
OperationsGapicClient
This class is deprecated. Use Google\LongRunning\OperationsClient instead.
OperationsClient
This class is deprecated. Use Google\LongRunning\OperationsClient instead.
CancelOperationRequest
The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
OperationsClient
Service Description: Manages long-running operations with an API service.
DeleteOperationRequest
The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
OperationsGapicClient
Service Description: Manages long-running operations with an API service.
GetOperationRequest
The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
ListOperationsRequest
The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
ListOperationsResponse
The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationInfo
A message representing the message types used by a long-running operation.
OperationsClient
Service Description: Manages long-running operations with an API service.
OperationsGrpcClient
Manages long-running operations with an API service.
WaitOperationRequest
The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].
Any
`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Api
Api is a light-weight descriptor for an API Interface.
BoolValue
Wrapper message for `bool`.
BytesValue
Wrapper message for `bytes`.
Descriptor
DescriptorPool
DoubleValue
Wrapper message for `double`.
Duration
A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.
Enum
Enum type definition.
EnumDescriptor
EnumValue
Enum value definition.
EnumValueDescriptor
Cardinality
Whether a field is optional, required, or repeated.
Kind
Basic field types.
Field
A single field of a message type.
Field_Cardinality
This class is deprecated. Use Google\Protobuf\Field\Cardinality instead.
Field_Kind
This class is deprecated. Use Google\Protobuf\Field\Kind instead.
FieldDescriptor
FieldMask
`FieldMask` represents a set of symbolic field paths, for example: paths: "f.a" paths: "f.b.d" Here `f` represents a field in some root message, `a` and `b` fields in the message found in `f`, and `d` a field found in the message in `f.b`.
FloatValue
Wrapper message for `float`.
GPBEmpty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Int32Value
Wrapper message for `int32`.
Int64Value
Wrapper message for `int64`.
AnyBase
Base class for Google\Protobuf\Any, this contains hand-written convenience methods like pack() and unpack().
CodedInputStream
CodedOutputStream
Descriptor
DescriptorPool
ExtensionRange
Generated from protobuf message <code>google.protobuf.DescriptorProto.ExtensionRange</code>
ReservedRange
Range of reserved tag numbers. Reserved tag numbers may not be used by fields or extension ranges in the same message. Reserved ranges may not overlap.
DescriptorProto
Describes a message type.
Edition
The full set of known editions.
EnumBuilderContext
EnumDescriptor
EnumReservedRange
Range of reserved numeric values. Reserved values may not be used by entries in the same enum. Reserved ranges may not overlap.
EnumDescriptorProto
Describes an enum type.
EnumOptions
Generated from protobuf message <code>google.protobuf.EnumOptions</code>
EnumValueDescriptorProto
Describes a value within an enum.
EnumValueOptions
Generated from protobuf message <code>google.protobuf.EnumValueOptions</code>
Declaration
Generated from protobuf message <code>google.protobuf.ExtensionRangeOptions.Declaration</code>
VerificationState
The verification state of the extension range.
ExtensionRangeOptions
Generated from protobuf message <code>google.protobuf.ExtensionRangeOptions</code>
EnforceNamingStyle
Protobuf type <code>google.protobuf.FeatureSet.EnforceNamingStyle</code>
EnumType
Protobuf type <code>google.protobuf.FeatureSet.EnumType</code>
FieldPresence
Protobuf type <code>google.protobuf.FeatureSet.FieldPresence</code>
JsonFormat
Protobuf type <code>google.protobuf.FeatureSet.JsonFormat</code>
MessageEncoding
Protobuf type <code>google.protobuf.FeatureSet.MessageEncoding</code>
RepeatedFieldEncoding
Protobuf type <code>google.protobuf.FeatureSet.RepeatedFieldEncoding</code>
Utf8Validation
Protobuf type <code>google.protobuf.FeatureSet.Utf8Validation</code>
DefaultSymbolVisibility
Protobuf type <code>google.protobuf.FeatureSet.VisibilityFeature.DefaultSymbolVisibility</code>
VisibilityFeature
Generated from protobuf message <code>google.protobuf.FeatureSet.VisibilityFeature</code>
FeatureSet
TODO Enums in C++ gencode (and potentially other languages) are not well scoped. This means that each of the feature enums below can clash with each other. The short names we've chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here.
FeatureSetEditionDefault
A map from every known edition with a unique set of defaults to its defaults. Not all editions may be contained here. For a given edition, the defaults at the closest matching edition ordered at or before it should be used. This field must be in strict ascending order by edition.
FeatureSetDefaults
A compiled specification for the defaults of a set of features. These messages are generated from FeatureSet extensions and can be used to seed feature resolution. The resolution with this object becomes a simple search for the closest matching edition, followed by proto merges.
FieldDescriptor
Label
Protobuf type <code>google.protobuf.FieldDescriptorProto.Label</code>
Type
Protobuf type <code>google.protobuf.FieldDescriptorProto.Type</code>
FieldDescriptorProto
Describes a field within a message.
CType
Protobuf type <code>google.protobuf.FieldOptions.CType</code>
EditionDefault
Generated from protobuf message <code>google.protobuf.FieldOptions.EditionDefault</code>
FeatureSupport
Information about the support window of a feature.
JSType
Protobuf type <code>google.protobuf.FieldOptions.JSType</code>
OptionRetention
If set to RETENTION_SOURCE, the option will be omitted from the binary.
OptionTargetType
This indicates the types of entities that the field may apply to when used as an option. If it is unset, then the field may be freely used as an option on any kind of entity.
FieldOptions
Generated from protobuf message <code>google.protobuf.FieldOptions</code>
FileDescriptor
FileDescriptorProto
Describes a complete .proto file.
FileDescriptorSet
The protocol compiler can output a FileDescriptorSet containing the .proto files it parses.
OptimizeMode
Generated classes can be optimized for speed or code size.
FileOptions
Generated from protobuf message <code>google.protobuf.FileOptions</code>
Semantic
Represents the identified object's effect on the element in the original .proto file.
Annotation
Generated from protobuf message <code>google.protobuf.GeneratedCodeInfo.Annotation</code>
GeneratedCodeInfo
Describes the relationship between generated code and its original source file. A GeneratedCodeInfo message is associated with only one generated source file, but may contain references to different source .proto files.
GPBDecodeException
GPBJsonWire
GPBLabel
GPBType
GPBUtil
GPBWire
GPBWireType
MapEntry
Parent class of all proto messages. Users should not instantiate this class or extend this class or its child classes by their own. See the comment of specific functions for more details.
MapField
MapField is used by generated protocol message classes to manipulate map fields. It can be used like native PHP array.
MapFieldIter
MapFieldIter is used to iterate MapField. It is also need for the foreach syntax.
Message
Parent class of all proto messages. Users should not instantiate this class or extend this class or its child classes by their own. See the comment of specific functions for more details.
MessageBuilderContext
MessageOptions
Generated from protobuf message <code>google.protobuf.MessageOptions</code>
MethodDescriptorProto
Describes a method of a service.
IdempotencyLevel
Is this method side-effect-free (or safe in HTTP parlance), or idempotent, or neither? HTTP based RPC implementation may choose GET verb for safe methods, and PUT verb for idempotent methods instead of the default POST.
MethodOptions
Generated from protobuf message <code>google.protobuf.MethodOptions</code>
OneofDescriptor
OneofDescriptorProto
Describes a oneof.
OneofField
OneofOptions
Generated from protobuf message <code>google.protobuf.OneofOptions</code>
RawInputStream
RepeatedField
This class is deprecated. Use Google\Protobuf\RepeatedField instead.
RepeatedFieldIter
RepeatedFieldIter is used to iterate RepeatedField. It is also need for the foreach syntax.
ServiceDescriptorProto
Describes a service.
ServiceOptions
Generated from protobuf message <code>google.protobuf.ServiceOptions</code>
SourceCodeInfo
Encapsulates information about the original source file from which a FileDescriptorProto was generated.
SymbolVisibility
Describes the 'visibility' of a symbol with respect to the proto import system. Symbols can only be imported when the visibility rules do not prevent it (ex: local symbols cannot be imported). Visibility modifiers can only set on `message` and `enum` as they are the only types available to be referenced from other files.
TimestampBase
Base class for Google\Protobuf\Timestamp, this contains hand-written convenience methods.
NamePart
The name of the uninterpreted option. Each string represents a segment in a dot-separated name. is_extension is true iff a segment represents an extension (denoted with parentheses in options specs in .proto files).
UninterpretedOption
A message representing a option the parser does not recognize. This only appears in options protos created by the compiler::Parser class.
ListValue
`ListValue` is a wrapper around a repeated field of values.
Method
Method represents a method of an API interface.
Mixin
Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method.
NullValue
`NullValue` is a singleton enumeration to represent the null value for the `Value` type union.
OneofDescriptor
Option
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
PrintOptions
RepeatedField
RepeatedField is used by generated protocol message classes to manipulate repeated fields. It can be used like native PHP array.
SourceContext
`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.
StringValue
Wrapper message for `string`.
Struct
`Struct` represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, `Struct` might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language.
Syntax
The syntax in which a protocol buffer element is defined.
Timestamp
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
Type
A protocol buffer message type.
UInt32Value
Wrapper message for `uint32`.
UInt64Value
Wrapper message for `uint64`.
Value
`Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
Any
Api
Duration
FieldMask
GPBEmpty
Descriptor
SourceContext
Struct
Timestamp
Type
Wrappers
Error
Result
Success
BaseStub
Base class for generated client stubs. Stub methods are expected to call _simpleRequest or _streamRequest and return the result.
BidiStreamingCall
Represents an active call that allows for sending and receiving messages in streams in any order.
ClientStreamingCall
Represents an active call that sends a stream of messages and then gets a single response.
DefaultCallInvoker
Default call invoker in the gRPC stub.
Interceptor
Represents an interceptor that intercept RPC invocations before call starts.
InterceptorChannel
This is a PRIVATE API and can change without notice.
MethodDescriptor
This is an experimental and incomplete implementation of gRPC server for PHP. APIs are _definitely_ going to be changed.
ServerCallReader
This is an experimental and incomplete implementation of gRPC server for PHP. APIs are _definitely_ going to be changed.
ServerCallWriter
This is an experimental and incomplete implementation of gRPC server for PHP. APIs are _definitely_ going to be changed.
ServerContext
This is an experimental and incomplete implementation of gRPC server for PHP. APIs are _definitely_ going to be changed.
ServerStreamingCall
Represents an active call that sends a single message and then gets a stream of responses.
UnaryCall
Represents an active call that sends a single message and then gets a single response.
BodySummarizer
Client
CookieJar
Cookie jar that stores cookies as an array
FileCookieJar
Persists non-session cookies using a JSON formatted file
SessionCookieJar
Persists cookies in the client session
SetCookie
Set-Cookie object
BadResponseException
Exception when an HTTP error occurs (4xx or 5xx error)
ClientException
Exception when a client error is encountered (4xx codes)
ConnectException
Exception thrown when a connection cannot be established.
InvalidArgumentException
RequestException
HTTP Request exception
ServerException
Exception when a server error is encountered (5xx codes)
TooManyRedirectsException
HTTP Request exception
TransferException
CurlFactory
Creates curl resources from a request
CurlHandler
HTTP handler that uses cURL easy handles as a transport layer.
CurlMultiHandler
Returns an asynchronous response using curl_multi_* functions.
MockHandler
Handler that returns responses or throw exceptions from a queue.
Proxy
Provides basic proxies for handlers.
StreamHandler
HTTP handler that uses PHP's HTTP stream wrapper.
HandlerStack
Creates a composed Guzzle handler function by stacking middlewares on top of an HTTP handler function.
MessageFormatter
Formats log messages using variable substitutions for requests, responses, and other transactional data.
Middleware
Functions used to create and wrap handlers with handler middleware.
Pool
Sends an iterator of requests concurrently using a capped pool size.
PrepareBodyMiddleware
Prepares requests that contain a body, adding the Content-Length, Content-Type, and Expect headers.
RedirectMiddleware
Request redirect middleware.
RequestOptions
This class contains a list of built-in Guzzle request options.
RetryMiddleware
Middleware that retries requests based on the boolean result of invoking the provided "decider" function.
TransferStats
Represents data at the point after it was transferred either successfully or after a network error.
Utils
AggregateException
Exception thrown when too many errors occur in the some() or any() methods.
CancellationException
Exception that is set as the reason for a promise that has been cancelled.
Coroutine
Creates a promise that is resolved using a generator that yields values or promises (somewhat similar to C#'s async keyword).
Create
Each
EachPromise
Represents a promise that iterates over many promises and invokes side-effect functions in the process.
FulfilledPromise
A promise that has been fulfilled.
Is
Promise
Promises/A+ implementation that avoids recursion when possible.
RejectedPromise
A promise that has been rejected.
RejectionException
A special exception that is thrown when waiting on a rejected promise.
TaskQueue
A task queue that executes tasks in a FIFO order.
Utils
AppendStream
Reads from multiple streams, one after the other.
BufferStream
Provides a buffer stream that can be written to to fill a buffer, and read from to remove bytes from the buffer.
CachingStream
Stream decorator that can cache previously read bytes from a sequentially read stream.
DroppingStream
Stream decorator that begins dropping data once the size of the underlying stream becomes too full.
MalformedUriException
Exception thrown if a URI cannot be parsed because it's malformed.
FnStream
Compose stream implementations based on a hash of functions.
Header
HttpFactory
Implements all of the PSR-17 interfaces.
InflateStream
Uses PHP's zlib.inflate filter to inflate zlib (HTTP deflate, RFC1950) or gzipped (RFC1952) content.
LazyOpenStream
Lazily reads or writes to a file that is opened only after an IO operation take place on the stream.
LimitStream
Decorator used to return only a subset of a stream.
Message
MimeType
MultipartStream
Stream that when read returns bytes for a streaming multipart or multipart/form-data stream.
NoSeekStream
Stream decorator that prevents a stream from being seeked.
PumpStream
Provides a read only stream that pumps data from a PHP callable.
Query
Request
PSR-7 request implementation.
Response
PSR-7 response implementation.
ServerRequest
Server-side HTTP request
Stream
PHP stream implementation.
StreamWrapper
Converts Guzzle streams into PHP stream resources.
UploadedFile
Uri
PSR-7 URI implementation.
UriComparator
Provides methods to determine if a modified URL should be considered cross-origin.
UriNormalizer
Provides methods to normalize and compare URIs.
UriResolver
Resolves a URI reference in the context of a base URI and the opposite way.
Utils
UriTemplate
Expands URI templates. Userland implementation of PECL uri_template.
FactoryCall
FactoryClass
FactoryFile
FactoryGenerator
Controls the process of extracting @factory doctags and generating factory method files.
FactoryMethod
Represents a single static factory method from a {@link Matcher} class.
FactoryParameter
GlobalFunctionFile
StaticMethodFile
IsArray
Matcher for array whose elements satisfy a sequence of matchers.
IsArrayContaining
Matches if an array contains an item satisfying a nested matcher.
IsArrayContainingInAnyOrder
Matches if an array contains a set of items satisfying nested matchers.
IsArrayContainingInOrder
Matches if an array contains a set of items satisfying nested matchers.
IsArrayContainingKey
Matches if an array contains the specified key.
IsArrayContainingKeyValuePair
Convenient base class for Matchers that require a value of a specific type.
IsArrayWithSize
Matches if array size satisfies a nested matcher.
MatchingOnce
SeriesMatchingOnce
AssertionError
BaseDescription
A {@link Hamcrest\Description} that is stored as a string.
BaseMatcher
BaseClass for all Matcher implementations.
IsEmptyTraversable
Matches if traversable is empty or non-empty.
IsTraversableWithSize
Matches if traversable size satisfies a nested matcher.
AllOf
Calculates the logical conjunction of multiple matchers. Evaluation is shortcut, so subsequent matchers are not called if an earlier matcher returns <code>false</code>.
AnyOf
Calculates the logical disjunction of multiple matchers. Evaluation is shortcut, so subsequent matchers are not called if an earlier matcher returns <code>true</code>.
CombinableMatcher
BaseClass for all Matcher implementations.
DescribedAs
Provides a custom description to another matcher.
Every
Convenient base class for Matchers that require a value of a specific type.
HasToString
Matches if array size satisfies a nested matcher.
Is
Decorates another Matcher, retaining the behavior but allowing tests to be slightly more expressive.
IsAnything
A matcher that always returns <code>true</code>.
IsCollectionContaining
Tests if an array contains values that match one or more Matchers.
IsEqual
Is the value equal to another value, as tested by the use of the "==" comparison operator?
IsIdentical
The same as {@link Hamcrest\Core\IsSame} but with slightly different semantics.
IsInstanceOf
Tests whether the value is an instance of a class.
IsNot
Calculates the logical negation of a matcher.
IsNull
Is the value null?
IsSame
Is the value the same object as another value? In PHP terms, does $a === $b?
IsTypeOf
Tests whether the value has a built-in type.
Set
Tests if a value (class, object, or array) has a named property.
ShortcutCombination
BaseClass for all Matcher implementations.
DiagnosingMatcher
Official documentation for this class is missing.
FeatureMatcher
Supporting class for matching a feature of an object. Implement <code>featureValueOf()</code> in a subclass to pull out the feature to be matched against.
SelfDescribingValue
A wrapper around any value so that it describes itself.
MatcherAssert
Matchers
A series of static factories for all hamcrest matchers.
NullDescription
Null implementation of {@link Hamcrest\Description}.
IsCloseTo
Is the value a number equal to a value within some range of acceptable error?
OrderingComparison
Convenient base class for Matchers that require a value of a specific type.
StringDescription
A {@link Hamcrest\Description} that is stored as a string.
IsEmptyString
Matches empty Strings (and null).
IsEqualIgnoringCase
Tests if a string is equal to another string, regardless of the case.
IsEqualIgnoringWhiteSpace
Tests if a string is equal to another string, ignoring any changes in whitespace.
MatchesPattern
Tests if the argument is a string that matches a regular expression.
StringContains
Tests if the argument is a string that contains a substring.
StringContainsIgnoringCase
Tests if the argument is a string that contains a substring ignoring case.
StringContainsInOrder
Tests if the value contains a series of substrings in a constrained order.
StringEndsWith
Tests if the argument is a string that ends with a substring.
StringStartsWith
Tests if the argument is a string that contains a substring.
SubstringMatcher
Convenient base class for Matchers that require a value of a specific type.
IsArray
Tests whether the value is an array.
IsBoolean
Tests whether the value is a boolean.
IsCallable
Tests whether the value is callable.
IsDouble
Tests whether the value is a float/double.
IsInteger
Tests whether the value is an integer.
IsNumeric
Tests whether the value is numeric.
IsObject
Tests whether the value is an object.
IsResource
Tests whether the value is a resource.
IsScalar
Tests whether the value is a scalar (boolean, integer, double, or string).
IsString
Tests whether the value is a string.
TypeSafeDiagnosingMatcher
Convenient base class for Matchers that require a value of a specific type.
TypeSafeMatcher
Convenient base class for Matchers that require a value of a specific type.
Util
Contains utility methods for handling Hamcrest matchers.
HasXPath
Matches if XPath applied to XML/HTML/XHTML document either evaluates to result matching the matcher or returns at least one node, matching the matcher if present.
AppCheckToken
AppCheckTokenOptions
DecodedAppCheckToken
VerifyAppCheckTokenResponse
ValidatedActionCodeSettings
FailedToCreateActionLink
FailedToCreateSessionCookie
DeleteUsersResult
MfaInfo
FailedToSendActionLink
FailedToSignIn
SignInResult
UserInfo
Represents a user's info from a third-party identity provider such as Google or Facebook.
UserMetaData
UserQuery
UserRecord
Query
A Query sorts and filters the data at a database location so only a subset of the child data is included.
Reference
A Reference represents a specific location in your database and can be used for reading or writing data to that database location.
RuleSet
Snapshot
A Snapshot contains data from a database location.
Transaction
GooglePlayAnalytics
ITunesConnectAnalytics
AnalyticsInfo
AndroidInfo
FailedToCreateDynamicLink
CreateDynamicLink
DynamicLinkStatistics
EventStatistics
FailedToGetStatisticsForDynamicLink
GetStatisticsForDynamicLink
IOSInfo
NavigationInfo
FailedToShortenLongDynamicLink
ShortenLongDynamicLink
SocialMetaTagInfo
DynamicLink
ApiConnectionFailed
AppCheckError
FailedToVerifyAppCheckToken
InvalidAppCheckToken
InvalidAppCheckTokenOptions
PermissionDenied
ApiConnectionFailed
AuthError
CredentialsMismatch
EmailExists
EmailNotFound
ExpiredOobCode
FailedToVerifySessionCookie
FailedToVerifyToken
InvalidCustomToken
InvalidOobCode
InvalidPassword
MissingPassword
OperationNotAllowed
PhoneNumberExists
ProviderLinkFailed
RevokedIdToken
RevokedSessionCookie
UserDisabled
UserNotFound
WeakPassword
ApiConnectionFailed
DatabaseError
DatabaseNotFound
PermissionDenied
PreconditionFailed
ReferenceHasNotBeenSnapshotted
TransactionFailed
UnsupportedQuery
InvalidArgumentException
LogicException
ApiConnectionFailed
AuthenticationError
InvalidArgument
InvalidMessage
MessagingError
NotFound
QuotaExceeded
ServerError
ServerUnavailable
OutOfRangeException
ApiConnectionFailed
OperationAborted
PermissionDenied
RemoteConfigError
ValidationFailed
VersionMismatch
VersionNotFound
RuntimeException
Factory
HttpClientOptions
AndroidConfig
ApnsConfig
AppInstance
CloudMessage
Condition
FcmOptions
MessageData
Messages
MessageTarget
MulticastSendReport
Notification
RawMessageFromArray
RegistrationToken
RegistrationTokens
SendReport
Topic
TopicSubscription
TopicSubscriptions
WebPushConfig
Condition
ConditionalValue
DefaultValue
ExplicitValue
FindVersions
Parameter
ParameterGroup
ParameterValue
PersonalizationValue
RolloutValue
TagColor
Template
UpdateOrigin
UpdateType
User
Version
VersionNumber
CreateUser
UpdateUser
CreateCustomToken
FetchGooglePublicKeys
VerifyIdToken
VerifySessionCookie
CustomTokenGenerator
CustomTokenCreationFailed
FetchingGooglePublicKeysFailed
IdTokenVerificationFailed
SessionCookieVerificationFailed
GooglePublicKeys
IdTokenVerifier
InsecureToken
SecureToken
SessionCookieVerifier
None
Parser
Duration
Adapted duration class from gamez/duration.
Firebase
FirebaseProject
FirebaseProjectManager
ServiceProvider
BreezeServiceProvider
InstallCommand
Base class for all commands.
AuthenticatedSessionController
EmailVerificationNotificationController
NewPasswordController
PasswordResetLinkController
RegisteredUserController
VerifyEmailController
EnsureEmailIsVerified
LoginRequest
Request represents an HTTP request.
AuthServiceProvider
AuthenticationTest
EmailVerificationTest
PasswordResetTest
RegistrationTest
AuthenticatedSessionController
ConfirmablePasswordController
EmailVerificationNotificationController
EmailVerificationPromptController
NewPasswordController
PasswordController
PasswordResetLinkController
RegisteredUserController
VerifyEmailController
ProfileController
LoginRequest
Request represents an HTTP request.
ProfileUpdateRequest
Request represents an HTTP request.
AppLayout
GuestLayout
AuthenticationTest
EmailVerificationTest
PasswordConfirmationTest
PasswordResetTest
PasswordUpdateTest
RegistrationTest
ProfileTest
AuthenticatedSessionController
ConfirmablePasswordController
EmailVerificationNotificationController
EmailVerificationPromptController
NewPasswordController
PasswordController
PasswordResetLinkController
RegisteredUserController
VerifyEmailController
ProfileController
HandleInertiaRequests
PasswordUpdateTest
ProfileTest
Logout
LoginForm
AuthenticationTest
EmailVerificationTest
PasswordConfirmationTest
PasswordResetTest
PasswordUpdateTest
RegistrationTest
ProfileTest
AuthorizationException
GateEvaluated
Gate
Response
AuthenticationException
AuthManager
AuthServiceProvider
ClearResetsCommand
Base class for all commands.
DatabaseUserProvider
EloquentUserProvider
Attempting
Authenticated
CurrentDeviceLogout
Failed
Lockout
Login
Logout
OtherDeviceLogout
PasswordReset
Registered
Validated
Verified
GenericUser
SendEmailVerificationNotification
Authenticate
AuthenticateWithBasicAuth
Authorize
EnsureEmailIsVerified
RequirePassword
ResetPassword
VerifyEmail
DatabaseTokenRepository
PasswordBroker
PasswordBrokerManager
PasswordResetServiceProvider
Recaller
RequestGuard
SessionGuard
TokenGuard
BroadcastController
AblyBroadcaster
Broadcaster
LogBroadcaster
NullBroadcaster
PusherBroadcaster
RedisBroadcaster
BroadcastEvent
BroadcastException
BroadcastManager
BroadcastServiceProvider
Channel
EncryptedPrivateChannel
PendingBroadcast
PresenceChannel
PrivateChannel
UniqueBroadcastEvent
Batch
BatchFactory
BusServiceProvider
ChainedBatch
DatabaseBatchRepository
Dispatcher
DynamoBatchRepository
BatchDispatched
PendingBatch
UniqueLock
UpdatedBatchJobCounts
ApcStore
ApcWrapper
ArrayLock
ArrayStore
CacheLock
CacheManager
CacheServiceProvider
CacheTableCommand
Base class for all commands.
ClearCommand
Base class for all commands.
ForgetCommand
Base class for all commands.
PruneStaleTagsCommand
Base class for all commands.
DatabaseLock
DatabaseStore
DynamoDbLock
DynamoDbStore
CacheEvent
CacheHit
CacheMissed
KeyForgotten
KeyWritten
FileLock
FileStore
Lock
LuaScripts
MemcachedConnector
MemcachedLock
MemcachedStore
NoLock
NullStore
PhpRedisLock
RateLimiter
GlobalLimit
Limit
Unlimited
RedisLock
RedisStore
RedisTaggedCache
RedisTagSet
Repository
TaggableStore
TaggedCache
TagSet
Arr
Collection
HigherOrderCollectionProxy
ItemNotFoundException
LazyCollection
MultipleItemsFoundException
HigherOrderWhenProxy
Repository
Application
An Application is the container for a collection of commands.
BufferedConsoleOutput
ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.
CacheCommandMutex
Command
Base class for all commands.
ContainerCommandLoader
ArtisanStarting
CommandFinished
CommandStarting
ScheduledBackgroundTaskFinished
ScheduledTaskFailed
ScheduledTaskFinished
ScheduledTaskSkipped
ScheduledTaskStarting
GeneratorCommand
Base class for all commands.
MigrationGeneratorCommand
Base class for all commands.
OutputStyle
Output decorator helpers for the Symfony Style Guide.
Parser
PromptValidationException
QuestionHelper
Symfony Style Guide compliant question helper.
CacheEventMutex
CacheSchedulingMutex
CallbackEvent
CommandBuilder
Event
Schedule
ScheduleClearCacheCommand
Base class for all commands.
ScheduleFinishCommand
Base class for all commands.
ScheduleInterruptCommand
Base class for all commands.
ScheduleListCommand
Base class for all commands.
ScheduleRunCommand
Base class for all commands.
ScheduleTestCommand
Base class for all commands.
ScheduleWorkCommand
Base class for all commands.
Alert
Ask
AskWithCompletion
BulletList
Choice
Component
Confirm
Error
Factory
Info
Line
EnsureDynamicContentIsHighlighted
EnsureNoPunctuation
EnsurePunctuation
EnsureRelativePaths
Secret
Task
TwoColumnDetail
Warn
BoundMethod
Container
ContextualBindingBuilder
EntryNotFoundException
RewindableGenerator
LockTimeoutException
BindingResolutionException
CircularDependencyException
ModelIdentifier
DecryptException
EncryptException
FileNotFoundException
LockTimeoutException
EntityNotFoundException
LimiterTimeoutException
ViewCompilationException
CookieJar
CookieServiceProvider
CookieValuePrefix
AddQueuedCookiesToResponse
EncryptCookies
Manager
ClassMorphViolationException
ConfigurationUrlParser
Connection
ConnectionResolver
ConnectionFactory
Connector
MySqlConnector
PostgresConnector
SQLiteConnector
SqlServerConnector
DatabaseInspectionCommand
Base class for all commands.
DbCommand
Base class for all commands.
DumpCommand
Base class for all commands.
FactoryMakeCommand
Base class for all commands.
BaseCommand
Base class for all commands.
FreshCommand
Base class for all commands.
InstallCommand
Base class for all commands.
MigrateCommand
Base class for all commands.
MigrateMakeCommand
Base class for all commands.
RefreshCommand
Base class for all commands.
ResetCommand
Base class for all commands.
RollbackCommand
Base class for all commands.
StatusCommand
Base class for all commands.
TableGuesser
MonitorCommand
Base class for all commands.
PruneCommand
Base class for all commands.
SeedCommand
Base class for all commands.
SeederMakeCommand
Base class for all commands.
ShowCommand
Base class for all commands.
ShowModelCommand
Base class for all commands.
TableCommand
Base class for all commands.
WipeCommand
Base class for all commands.
DatabaseManager
DatabaseServiceProvider
DatabaseTransactionRecord
DatabaseTransactionsManager
TimestampType
DeadlockException
ObservedBy
ScopedBy
BroadcastableModelEventOccurred
Builder
ArrayObject
AsArrayObject
AsCollection
AsEncryptedArrayObject
AsEncryptedCollection
AsEnumArrayObject
AsEnumCollection
AsStringable
Attribute
Json
Collection
BelongsToManyRelationship
BelongsToRelationship
CrossJoinSequence
Factory
Relationship
Sequence
HigherOrderBuilderProxy
InvalidCastException
JsonEncodingException
MassAssignmentException
MissingAttributeException
Model
ModelNotFoundException
PendingHasThroughRelationship
QueueEntityResolver
RelationNotFoundException
BelongsTo
BelongsToMany
HasMany
HasManyThrough
HasOne
HasOneOrMany
HasOneThrough
MorphMany
MorphOne
MorphOneOrMany
MorphPivot
MorphTo
MorphToMany
Pivot
Relation
SoftDeletingScope
ConnectionEstablished
ConnectionEvent
DatabaseBusy
DatabaseRefreshed
MigrationEnded
MigrationEvent
MigrationsEnded
MigrationsEvent
MigrationsStarted
MigrationStarted
ModelPruningFinished
ModelPruningStarting
ModelsPruned
NoPendingMigrations
QueryExecuted
SchemaDumped
SchemaLoaded
StatementPrepared
TransactionBeginning
TransactionCommitted
TransactionCommitting
TransactionRolledBack
Grammar
LazyLoadingViolationException
LostConnectionException
DatabaseMigrationRepository
Migration
MigrationCreator
Migrator
MigrationServiceProvider
MultipleColumnsSelectedException
MultipleRecordsFoundException
MySqlConnection
Connection
MySqlDriver
PostgresDriver
SQLiteDriver
SqlServerConnection
SqlServerDriver
PostgresConnection
Builder
Expression
Grammar
MySqlGrammar
PostgresGrammar
SQLiteGrammar
SqlServerGrammar
IndexHint
JoinClause
JoinLateralClause
MySqlProcessor
PostgresProcessor
Processor
SQLiteProcessor
SqlServerProcessor
QueryException
RecordsNotFoundException
Blueprint
Builder
ColumnDefinition
ForeignIdColumnDefinition
ForeignKeyDefinition
ChangeColumn
Grammar
MySqlGrammar
PostgresGrammar
RenameColumn
SQLiteGrammar
SqlServerGrammar
IndexDefinition
MySqlBuilder
MySqlSchemaState
PostgresBuilder
PostgresSchemaState
SchemaState
SQLiteBuilder
SqliteSchemaState
SqlServerBuilder
Seeder
SQLiteConnection
SQLiteDatabaseDoesNotExistException
SqlServerConnection
UniqueConstraintViolationException
Encrypter
EncryptionServiceProvider
MissingAppKeyException
CallQueuedListener
Dispatcher
EventServiceProvider
InvokeQueuedClosure
NullDispatcher
QueuedClosure
AwsS3V3Adapter
Filesystem
FilesystemAdapter
FilesystemManager
FilesystemServiceProvider
LockableFile
AliasLoader
Application
EmailVerificationRequest
Request represents an HTTP request.
User
BootProviders
HandleExceptions
LoadConfiguration
LoadEnvironmentVariables
RegisterFacades
RegisterProviders
SetRequestForConsole
PendingChain
PendingClosureDispatch
PendingDispatch
CacheBasedMaintenanceMode
Cloud
ComposerScripts
AboutCommand
Base class for all commands.
CastMakeCommand
Base class for all commands.
ChannelListCommand
Base class for all commands.
ChannelMakeCommand
Base class for all commands.
ClearCompiledCommand
Base class for all commands.
CliDumper
CliDumper dumps variables for command line output.
ClosureCommand
Base class for all commands.
ComponentMakeCommand
Base class for all commands.
ConfigCacheCommand
Base class for all commands.
ConfigClearCommand
Base class for all commands.
ConfigShowCommand
Base class for all commands.
ConsoleMakeCommand
Base class for all commands.
DocsCommand
Base class for all commands.
DownCommand
Base class for all commands.
EnvironmentCommand
Base class for all commands.
EnvironmentDecryptCommand
Base class for all commands.
EnvironmentEncryptCommand
Base class for all commands.
EventCacheCommand
Base class for all commands.
EventClearCommand
Base class for all commands.
EventGenerateCommand
Base class for all commands.
EventListCommand
Base class for all commands.
EventMakeCommand
Base class for all commands.
ExceptionMakeCommand
Base class for all commands.
JobMakeCommand
Base class for all commands.
Kernel
KeyGenerateCommand
Base class for all commands.
LangPublishCommand
Base class for all commands.
ListenerMakeCommand
Base class for all commands.
MailMakeCommand
Base class for all commands.
ModelMakeCommand
Base class for all commands.
NotificationMakeCommand
Base class for all commands.
ObserverMakeCommand
Base class for all commands.
OptimizeClearCommand
Base class for all commands.
OptimizeCommand
Base class for all commands.
PackageDiscoverCommand
Base class for all commands.
PolicyMakeCommand
Base class for all commands.
ProviderMakeCommand
Base class for all commands.
QueuedCommand
RequestMakeCommand
Base class for all commands.
ResourceMakeCommand
Base class for all commands.
RouteCacheCommand
Base class for all commands.
RouteClearCommand
Base class for all commands.
RouteListCommand
Base class for all commands.
RuleMakeCommand
Base class for all commands.
ScopeMakeCommand
Base class for all commands.
ServeCommand
Base class for all commands.
StorageLinkCommand
Base class for all commands.
StorageUnlinkCommand
Base class for all commands.
StubPublishCommand
Base class for all commands.
TestMakeCommand
Base class for all commands.
UpCommand
Base class for all commands.
VendorPublishCommand
Base class for all commands.
ViewCacheCommand
Base class for all commands.
ViewClearCommand
Base class for all commands.
ViewMakeCommand
Base class for all commands.
EnvironmentDetector
DiscoverEvents
LocaleUpdated
MaintenanceModeDisabled
MaintenanceModeEnabled
PublishingStubs
VendorTagPublished
Handler
RegisterErrorViewPaths
ReportableHandler
WhoopsExceptionRenderer
WhoopsHandler
FileBasedMaintenanceMode
RequestHandled
FormRequest
Request represents an HTTP request.
HtmlDumper
HtmlDumper dumps variables as HTML.
Kernel
MaintenanceModeBypassCookie
CheckForMaintenanceMode
ConvertEmptyStringsToNull
HandlePrecognitiveRequests
PreventRequestsDuringMaintenance
TransformsRequest
TrimStrings
ValidatePostSize
VerifyCsrfToken
Inspiring
MaintenanceModeManager
Mix
PackageManifest
Precognition
ProviderRepository
ArtisanServiceProvider
ComposerServiceProvider
ConsoleSupportServiceProvider
FormRequestServiceProvider
FoundationServiceProvider
PrecognitionCallableDispatcher
PrecognitionControllerDispatcher
AuthServiceProvider
EventServiceProvider
RouteServiceProvider
DatabaseTransactionsManager
RefreshDatabaseState
TestCase
Wormhole
Vite
ViteManifestNotFoundException
AbstractHasher
Argon2IdHasher
ArgonHasher
BcryptHasher
HashManager
HashServiceProvider
ConnectionException
ConnectionFailed
RequestSending
ResponseReceived
Factory
HttpClientException
PendingRequest
Pool
Request
RequestException
Response
ResponseSequence
HttpResponseException
PostTooLargeException
HttpException.
ThrottleRequestsException
HttpException.
File
A file in the file system.
JsonResponse
Response represents an HTTP response in JSON format.
AddLinkHeadersForPreloadedAssets
CheckResponseForModifications
FrameGuard
HandleCors
SetCacheHeaders
TrustHosts
TrustProxies
RedirectResponse
RedirectResponse represents an HTTP response doing a redirect.
Request
Request represents an HTTP request.
AnonymousResourceCollection
JsonResource
PaginatedResourceResponse
ResourceCollection
ResourceResponse
MergeValue
MissingValue
Response
Response represents an HTTP response.
File
A file uploaded through a form.
FileFactory
MimeType
UploadedFile
A file uploaded through a form.
MessageLogged
Logger
LogManager
LogServiceProvider
Attachment
MessageSending
MessageSent
Mailable
Address
Attachment
Content
Envelope
Headers
Mailer
MailManager
MailServiceProvider
Markdown
Message
PendingMail
SendQueuedMailable
SentMessage
TextMessage
ArrayTransport
LogTransport
SesTransport
SesV2Transport
Action
AnonymousNotifiable
ChannelManager
BroadcastChannel
DatabaseChannel
MailChannel
NotificationTableCommand
Base class for all commands.
DatabaseNotification
DatabaseNotificationCollection
BroadcastNotificationCreated
NotificationFailed
NotificationSending
NotificationSent
BroadcastMessage
DatabaseMessage
MailMessage
SimpleMessage
Notification
NotificationSender
NotificationServiceProvider
SendQueuedNotifications
AbstractCursorPaginator
AbstractPaginator
Cursor
CursorPaginator
LengthAwarePaginator
PaginationServiceProvider
PaginationState
Paginator
UrlWindow
Hub
Pipeline
PipelineServiceProvider
ProcessFailedException
ProcessTimedOutException
RuntimeException for the Process Component.
Factory
FakeInvokedProcess
FakeProcessDescription
FakeProcessResult
FakeProcessSequence
InvokedProcess
InvokedProcessPool
PendingProcess
Pipe
Pool
ProcessPoolResults
ProcessResult
WithoutRelations
BeanstalkdQueue
CallQueuedClosure
CallQueuedHandler
Manager
BeanstalkdConnector
DatabaseConnector
NullConnector
RedisConnector
SqsConnector
SyncConnector
BatchesTableCommand
Base class for all commands.
ClearCommand
Base class for all commands.
FailedTableCommand
Base class for all commands.
FlushFailedCommand
Base class for all commands.
ForgetFailedCommand
Base class for all commands.
ListenCommand
Base class for all commands.
ListFailedCommand
Base class for all commands.
MonitorCommand
Base class for all commands.
PruneBatchesCommand
Base class for all commands.
PruneFailedJobsCommand
Base class for all commands.
RestartCommand
Base class for all commands.
RetryBatchCommand
Base class for all commands.
RetryCommand
Base class for all commands.
TableCommand
Base class for all commands.
WorkCommand
Base class for all commands.
DatabaseQueue
JobExceptionOccurred
JobFailed
JobPopped
JobPopping
JobProcessed
JobProcessing
JobQueued
JobQueueing
JobReleasedAfterException
JobRetryRequested
JobTimedOut
Looping
QueueBusy
WorkerStopping
DatabaseFailedJobProvider
DatabaseUuidFailedJobProvider
DynamoDbFailedJobProvider
FileFailedJobProvider
NullFailedJobProvider
InvalidPayloadException
BeanstalkdJob
DatabaseJob
DatabaseJobRecord
Job
JobName
RedisJob
SqsJob
SyncJob
Listener
ListenerOptions
LuaScripts
ManuallyFailedException
MaxAttemptsExceededException
RateLimited
RateLimitedWithRedis
SkipIfBatchCancelled
ThrottlesExceptions
ThrottlesExceptionsWithRedis
WithoutOverlapping
NullQueue
Queue
QueueManager
QueueServiceProvider
RedisQueue
SqsQueue
SyncQueue
TimeoutExceededException
Worker
WorkerOptions
Connection
PhpRedisClusterConnection
PhpRedisConnection
PredisClusterConnection
PredisConnection
PhpRedisConnector
PredisConnector
CommandExecuted
ConcurrencyLimiter
ConcurrencyLimiterBuilder
DurationLimiter
DurationLimiterBuilder
RedisManager
RedisServiceProvider
AbstractRouteCollection
CallableDispatcher
CompiledRouteCollection
ControllerMakeCommand
Base class for all commands.
MiddlewareMakeCommand
Base class for all commands.
Controller
ControllerDispatcher
ControllerMiddlewareOptions
Middleware
PreparingResponse
ResponsePrepared
RouteMatched
Routing
BackedEnumCaseNotFoundException
InvalidSignatureException
HttpException.
StreamedResponseException
UrlGenerationException
ImplicitRouteBinding
HostValidator
MethodValidator
SchemeValidator
UriValidator
SubstituteBindings
ThrottleRequests
ThrottleRequestsWithRedis
ValidateSignature
MiddlewareNameResolver
PendingResourceRegistration
PendingSingletonResourceRegistration
Pipeline
This extended pipeline catches any exceptions that occur during each slice.
RedirectController
Redirector
ResourceRegistrar
ResponseFactory
Route
RouteAction
RouteBinding
RouteCollection
RouteFileRegistrar
RouteGroup
RouteParameterBinder
Router
RouteRegistrar
RouteSignatureParameters
RouteUri
RouteUrlGenerator
RoutingServiceProvider
SortedMiddleware
UrlGenerator
ViewController
ArraySessionHandler
CacheBasedSessionHandler
SessionTableCommand
Base class for all commands.
CookieSessionHandler
DatabaseSessionHandler
EncryptedStore
FileSessionHandler
AuthenticateSession
StartSession
NullSessionHandler
SessionManager
SessionServiceProvider
Store
SymfonySessionDecorator
TokenMismatchException
AggregateServiceProvider
Benchmark
Carbon
A simple API extension for DateTime.
Composer
ConfigurationUrlParser
DateFactory
DefaultProviders
Env
MathException
App
Artisan
Auth
Blade
Broadcast
Bus
Cache
Config
Cookie
Crypt
Date
DB
Event
Facade
File
Gate
Hash
Http
Lang
Log
Mail
Notification
ParallelTesting
Password
Pipeline
Process
Queue
RateLimiter
Redirect
Redis
Request
Response
Route
Schema
Session
Storage
URL
Validator
View
Vite
Fluent
HigherOrderTapProxy
HtmlString
Js
Lottery
Manager
MessageBag
MultipleInstanceManager
NamespacedItemResolver
Number
Optional
Pluralizer
ProcessUtils
ProcessUtils is a bunch of utility methods.
Reflector
ServiceProvider
Sleep
Str
Stringable
BatchFake
BatchRepositoryFake
BusFake
ChainedBatchTruthTest
EventFake
MailFake
NotificationFake
PendingBatchFake
PendingChainFake
PendingMailFake
QueueFake
Timebox
ValidatedInput
ViewErrorBag
AssertableJsonString
CountInDatabase
HasInDatabase
NotSoftDeletedInDatabase
SeeInOrder
SoftDeletedInDatabase
InvalidArgumentException
AssertableJson
LoggedExceptionCollection
ParallelConsoleOutput
ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.
ParallelRunner
ParallelTesting
ParallelTestingServiceProvider
PendingCommand
TestComponent
TestResponse
TestView
ArrayLoader
FileLoader
MessageSelector
PotentiallyTranslatedString
TranslationServiceProvider
Translator
ClosureValidationRule
FilterEmailValidation
ConditionalRules
DatabasePresenceVerifier
Factory
InvokableValidationRule
NestedRules
NotPwnedVerifier
Rule
Can
Dimensions
Enum
ExcludeIf
Exists
File
ImageFile
In
NotIn
Password
ProhibitedIf
RequiredIf
Unique
UnauthorizedException
ValidationData
ValidationException
ValidationRuleParser
ValidationServiceProvider
Validator
AnonymousComponent
AppendableAttributeValue
BladeCompiler
Compiler
ComponentTagCompiler
Component
ComponentAttributeBag
ComponentSlot
DynamicComponent
CompilerEngine
Engine
EngineResolver
FileEngine
PhpEngine
Factory
FileViewFinder
InvokableComponentVariable
ShareErrorsFromSession
View
ViewException
ViewName
ViewServiceProvider
ConfirmPrompt
FormRevertedException
NonInteractiveValidationException
FormBuilder
FormStep
Key
MultiSearchPrompt
MultiSelectPrompt
Note
BufferedConsoleOutput
ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.
ConsoleOutput
ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.
PasswordPrompt
PausePrompt
Progress
Prompt
SearchPrompt
SelectPrompt
Spinner
SuggestPrompt
Table
Terminal
TextareaPrompt
TextPrompt
ConfirmPromptRenderer
MultiSearchPromptRenderer
MultiSelectPromptRenderer
NoteRenderer
PasswordPromptRenderer
PausePromptRenderer
ProgressRenderer
Renderer
SearchPromptRenderer
SelectPromptRenderer
SpinnerRenderer
SuggestPromptRenderer
TableRenderer
TextareaPromptRenderer
TextPromptRenderer
AddCommand
Base class for all commands.
InstallCommand
Base class for all commands.
PublishCommand
Base class for all commands.
SailServiceProvider
PruneExpired
Base class for all commands.
TokenAuthenticated
MissingAbilityException
MissingScopeException
Guard
CsrfCookieController
AuthenticateSession
CheckAbilities
CheckForAnyAbility
CheckForAnyScope
CheckScopes
EnsureFrontendRequestsAreStateful
NewAccessToken
PersonalAccessToken
Sanctum
SanctumServiceProvider
TransientToken
InvalidSignatureException
MissingSecretKeyException
PhpVersionNotSupportedException
SerializableClosure
Native
Signed
Hmac
ClosureScope
ClosureStream
ReflectionClosure
SelfReference
UnsignedSerializableClosure
ClassAliasAutoloader
TinkerCommand
Base class for all commands.
TinkerCaster
TinkerServiceProvider
FcmChannel
FcmMessage
FcmResource
Notification
Configuration
Configuration container for the JWT Builder and Parser
CannotDecodeContent
CannotEncodeContent
ChainedFormatter
JoseEncoder
A utilitarian class that encodes and decodes data according to JOSE specifications
MicrosecondBasedDateConversion
UnifyAudience
UnixTimestampDates
JwtFacade
Blake2b
CannotSignPayload
ConversionFailed
Sha256
Sha384
Sha512
Ecdsa
Eddsa
Sha256
Sha384
Sha512
Hmac
InvalidKeyProvided
FileCouldNotBeRead
InMemory
OpenSSL
Sha256
Sha384
Sha512
Rsa
Builder
DataSet
InvalidTokenStructure
Parser
Plain
RegisteredClaimGiven
Signature
UnsupportedHeaderFound
CannotValidateARegisteredClaim
HasClaim
HasClaimWithValue
IdentifiedBy
IssuedBy
LeewayCannotBeNegative
LooseValidAt
PermittedFor
RelatedTo
SignedWith
SignedWithOneInSet
SignedWithUntilDate
StrictValidAt
ConstraintViolation
NoConstraintsGiven
RequiredConstraintsViolated
Validator
CommonMarkConverter
Converts CommonMark-compatible Markdown to HTML.
Bracket
Delimiter
DelimiterStack
DelimiterProcessorCollection
Environment
AbstractEvent
Base class for classes containing event data.
DocumentParsedEvent
Event dispatched when the document has been fully parsed
DocumentPreParsedEvent
Event dispatched when the document is about to be parsed
DocumentPreRenderEvent
Event dispatched just before rendering begins
DocumentRenderedEvent
Base class for classes containing event data.
AlreadyInitializedException
InvalidArgumentException
IOException
LogicException
MissingDependencyException
UnexpectedEncodingException
AttributesExtension
AttributesListener
Attributes
Block-level element
AttributesInline
AttributesBlockContinueParser
Base class for a block parser
AttributesBlockStartParser
AttributesInlineParser
AutolinkExtension
EmailAutolinkParser
UrlAutolinkParser
CommonMarkCoreExtension
EmphasisDelimiterProcessor
BlockQuote
Block-level element
FencedCode
Block-level element
Heading
Block-level element
HtmlBlock
Block-level element
IndentedCode
Block-level element
ListBlock
Block-level element
ListData
ListItem
Block-level element
ThematicBreak
Block-level element
AbstractWebResource
Code
Emphasis
HtmlInline
Image
Link
Strong
BlockQuoteParser
Base class for a block parser
BlockQuoteStartParser
FencedCodeParser
Base class for a block parser
FencedCodeStartParser
HeadingParser
Base class for a block parser
HeadingStartParser
HtmlBlockParser
Base class for a block parser
HtmlBlockStartParser
IndentedCodeParser
Base class for a block parser
IndentedCodeStartParser
ListBlockParser
Base class for a block parser
ListBlockStartParser
ListItemParser
Base class for a block parser
ThematicBreakParser
Base class for a block parser
ThematicBreakStartParser
AutolinkParser
BacktickParser
BangParser
CloseBracketParser
EntityParser
EscapableParser
HtmlInlineParser
OpenBracketParser
BlockQuoteRenderer
FencedCodeRenderer
HeadingRenderer
HtmlBlockRenderer
IndentedCodeRenderer
ListBlockRenderer
ListItemRenderer
ThematicBreakRenderer
CodeRenderer
EmphasisRenderer
HtmlInlineRenderer
ImageRenderer
LinkRenderer
StrongRenderer
ApplyDefaultAttributesProcessor
DefaultAttributesExtension
DescriptionListExtension
ConsecutiveDescriptionListMerger
LooseDescriptionHandler
Description
Block-level element
DescriptionList
Block-level element
DescriptionTerm
Block-level element
DescriptionContinueParser
Base class for a block parser
DescriptionListContinueParser
Base class for a block parser
DescriptionStartParser
DescriptionTermContinueParser
Base class for a block parser
DescriptionListRenderer
DescriptionRenderer
DescriptionTermRenderer
DisallowedRawHtmlExtension
DisallowedRawHtmlRenderer
OscaroteroEmbedAdapter
DomainFilteringAdapter
Embed
Block-level element
EmbedExtension
EmbedParser
EmbedProcessor
EmbedRenderer
EmbedStartParser
ExternalLinkExtension
ExternalLinkProcessor
AnonymousFootnotesListener
FixOrphanedFootnotesAndRefsListener
GatherFootnotesListener
NumberFootnotesListener
FootnoteExtension
Footnote
Block-level element
FootnoteBackref
Link from the footnote on the bottom of the document back to the reference
FootnoteContainer
Block-level element
FootnoteRef
AnonymousFootnoteRefParser
FootnoteParser
Base class for a block parser
FootnoteRefParser
FootnoteStartParser
FootnoteBackrefRenderer
FootnoteContainerRenderer
FootnoteRefRenderer
FootnoteRenderer
LibYamlFrontMatterParser
SymfonyYamlFrontMatterParser
InvalidFrontMatterException
FrontMatterExtension
FrontMatterParser
MarkdownInputWithFrontMatter
FrontMatterPostRenderListener
FrontMatterPreParser
RenderedContentWithFrontMatter
GithubFlavoredMarkdownExtension
HeadingPermalink
Represents an anchor link within a heading
HeadingPermalinkExtension
Extension which automatically anchor links to heading elements
HeadingPermalinkProcessor
Searches the Document for Heading elements and adds HeadingPermalinks to each one
HeadingPermalinkRenderer
Renders the HeadingPermalink elements
ChildRenderer
Simply renders child elements as-is, adding newlines as needed.
InlinesOnlyExtension
CallbackGenerator
StringTemplateLinkGenerator
Mention
MentionExtension
MentionParser
DashParser
EllipsesParser
Quote
QuoteParser
QuoteProcessor
ReplaceUnpairedQuotesListener
Identifies any lingering Quote nodes that were missing pairs and converts them into Text nodes
SmartPunctExtension
Strikethrough
StrikethroughDelimiterProcessor
StrikethroughExtension
StrikethroughRenderer
Table
Block-level element
TableCell
Block-level element
TableCellRenderer
TableExtension
TableParser
Base class for a block parser
TableRenderer
TableRow
Block-level element
TableRowRenderer
TableSection
Block-level element
TableSectionRenderer
TableStartParser
TableOfContents
Block-level element
TableOfContentsPlaceholder
Block-level element
AsIsNormalizerStrategy
FlatNormalizerStrategy
RelativeNormalizerStrategy
TableOfContentsBuilder
TableOfContentsExtension
TableOfContentsGenerator
TableOfContentsPlaceholderParser
Base class for a block parser
TableOfContentsPlaceholderRenderer
TableOfContentsRenderer
TaskListExtension
TaskListItemMarker
TaskListItemMarkerParser
TaskListItemMarkerRenderer
GithubFlavoredMarkdownConverter
Converts GitHub Flavored Markdown to HTML.
MarkdownInput
MarkdownConverter
AbstractBlock
Block-level element
Document
Block-level element
Paragraph
Block-level element
AbstractInline
AbstractStringContainer
Newline
Text
Node
NodeIterator
NodeWalker
NodeWalkerEvent
Query
StringContainerHelper
SlugNormalizer
Creates URL-friendly strings based on the given string input
TextNormalizer
UniqueSlugNormalizer
RenderedContent
AbstractBlockContinueParser
Base class for a block parser
BlockContinue
Result object for continuing parsing of a block; see static methods for constructors.
BlockStart
Result object for starting parsing of a block; see static methods for constructors
DocumentBlockParser
Parser implementation which ensures everything is added to the root-level Document
ParagraphParser
Base class for a block parser
Cursor
InlineParserMatch
NewlineParser
InlineParserContext
MarkdownParser
ParserLogicException
MemoryLimitedReferenceMap
Reference
ReferenceMap
A collection of references, indexed by label
ReferenceParser
DocumentRenderer
ParagraphRenderer
HtmlDecorator
HtmlRenderer
NewlineRenderer
TextRenderer
NoMatchingRendererException
Html5EntityDecoder
HtmlElement
HtmlFilter
LinkParserHelper
RegexHelper
Provides regular expressions and utilities for parsing Markdown
SpecReader
Reads in a CommonMark spec document and extracts the input/output examples for testing against them
UrlEncoder
Xml
Utility class for handling/generating XML and HTML
MarkdownToXmlConverter
XmlRenderer
Configuration
InvalidConfigurationException
UnknownOptionException
ValidationException
ReadOnlyConfiguration
Provides read-only access to a given Configuration object
ChecksumAlgoIsNotSupported
Config
CorruptedPathDetected
DecoratedAdapter
DirectoryAttributes
DirectoryListing
FileAttributes
Filesystem
InvalidStreamProvided
InvalidVisibilityProvided
MountManager
PathPrefixer
PathTraversalDetected
PortableVisibilityGuard
ResolveIdenticalPathConflict
SymbolicLinkEncountered
UnableToCheckDirectoryExistence
UnableToCheckExistence
UnableToCheckFileExistence
UnableToCopyFile
UnableToCreateDirectory
UnableToDeleteDirectory
UnableToDeleteFile
UnableToGeneratePublicUrl
UnableToGenerateTemporaryUrl
UnableToListContents
UnableToMountFilesystem
UnableToMoveFile
UnableToProvideChecksum
UnableToReadFile
UnableToResolveFilesystemMount
UnableToRetrieveMetadata
UnableToSetVisibility
UnableToWriteFile
PortableVisibilityConverter
UnreadableFileEncountered
ChainedPublicUrlGenerator
PrefixPublicUrlGenerator
ShardedPrefixPublicUrlGenerator
Visibility
WhitespacePathNormalizer
FallbackMimeTypeDetector
LocalFilesystemAdapter
EmptyExtensionToMimeTypeMap
ExtensionMimeTypeDetector
FinfoMimeTypeDetector
GeneratedExtensionToMimeTypeMap
OverridingExtensionToMimeTypeMap
BatchCache
BatchCacheDeprecated
CacheManager
MemoryCache
MemoryCacheDeprecated
Cell
ChunkReader
ExportMakeCommand
Base class for all commands.
ImportMakeCommand
Base class for all commands.
DefaultValueBinder
AfterBatch
AfterChunk
AfterImport
AfterSheet
BeforeExport
BeforeImport
BeforeSheet
BeforeWriting
ImportFailed
Excel
ExcelServiceProvider
ConcernConflictException
NoFilenameGivenException
NoFilePathGivenException
NoSheetsFoundException
NoTypeDetectedException
RowSkippedException
SheetNotFoundException
UnreadableFileException
Excel
ReaderFactory
WriterFactory
ExcelFake
Disk
Filesystem
LocalTemporaryFile
RemoteTemporaryFile
TemporaryFile
TemporaryFileFactory
ChunkReadFilter
LimitFilter
HeadingRowImport
ArrayHelper
CellHelper
FileTypeDetector
EndRowFinder
HeadingRowExtractor
HeadingRowFormatter
ModelImporter
ModelManager
CascadePersistManager
AfterImportJob
AppendDataToSheet
AppendPaginatedToSheet
AppendQueryToSheet
AppendViewToSheet
CloseSheet
LocalizeJob
QueueExport
QueueImport
ReadChunk
StoreQueuedExport
MappedReader
CellMiddleware
ConvertEmptyCellValuesToNull
TrimCellValue
DownloadCollectionMixin
DownloadQueryMacro
ImportAsMacro
ImportMacro
StoreCollectionMixin
StoreQueryMacro
QueuedWriter
Reader
Row
SettingsProvider
Sheet
DbTransactionHandler
NullTransactionHandler
TransactionManager
Failure
RowValidator
ValidationException
Writer
DosTimeOverflowException
This Exception gets invoked if a file wasn't found
FileNotFoundException
This Exception gets invoked if a file wasn't found
FileNotReadableException
This Exception gets invoked if a file wasn't found
FileSizeIncorrectException
This Exception gets invoked if a file is not as large as it was specified.
OverflowException
This Exception gets invoked if a counter value exceeds storage size
ResourceActionException
This Exception gets invoked if a resource like `fread` returns false
SimulationFileUnknownException
This Exception gets invoked if a strict simulation is executed and the file information can't be determined without reading the entire file.
StreamNotReadableException
This Exception gets invoked if a stream can't be read.
StreamNotSeekableException
This Exception gets invoked if a non seekable stream is provided and zero headers are disabled.
Exception
ZipStream
Streamed, dynamically generated zip archives.
CentralDirectoryFileHeaderTest
DataDescriptorTest
EndlessCycleStream
EndOfCentralDirectoryTest
FaultInjectionResource
LocalFileHeaderTest
PackFieldTest
TimeTest
DataDescriptorTest
EndOfCentralDirectoryLocatorTest
EndOfCentralDirectoryTest
ExtendedInformationExtraFieldTest
ZipStreamTest
ExtendedInformationExtraFieldTest
Exception
Functions
Operations
Decomposition
LU
QR
Div0Exception
Exception
Functions
Operations
Addition
DirectSum
Division
Multiplication
Operator
Subtraction
MockeryTestCase
TestListener
TestListenerTrait
CompositeExpectation
Configuration
Container
Container for mock objects
AtLeast
AtMost
CountValidatorAbstract
Exact
Exception
BadMethodCallException
InvalidArgumentException
InvalidCountException
InvalidOrderException
NoMatchingExpectationException
RuntimeException
Exception
Expectation
ExpectationDirector
ExpectsHigherOrderMessage
CachingGenerator
DefinedTargetClass
Method
MockConfiguration
This class describes the configuration of mocks and hides away some of the reflection implementation
MockConfigurationBuilder
MockDefinition
MockNameBuilder
Parameter
AvoidMethodClashPass
CallTypeHintPass
ClassAttributesPass
ClassNamePass
ClassPass
ConstantsPass
InstanceMockPass
InterfacePass
MagicMethodTypeHintsPass
MethodDefinitionPass
RemoveBuiltinMethodsThatAreFinalPass
The standard Mockery\Mock class includes some methods to ease mocking, such as __wakeup, however if the target has a final __wakeup method, it can't be mocked. This pass removes the builtin methods where they are final on the target
RemoveDestructorPass
Remove mock's empty destructor if we tend to use original class destructor
RemoveUnserializeForInternalSerializableClassesPass
Internal classes can not be instantiated with the newInstanceWithoutArgs reflection method, so need the serialization hack. If the class also implements Serializable, we need to replace the standard unserialize method definition with a dummy
TraitPass
StringManipulationGenerator
UndefinedTargetClass
HigherOrderMessage
Instantiator
This is a trimmed down version of https://github.com/doctrine/instantiator, without the caching mechanism.
EvalLoader
RequireLoader
AndAnyOtherArgs
Any
AnyArgs
AnyOf
Closure
Contains
Ducktype
HasKey
HasValue
IsEqual
IsSame
MatcherAbstract
MultiArgumentClosure
MustBe
NoArgs
Not
NotAnyOf
Pattern
Subset
Type
MethodCall
Mock
QuickDefinitionsConfiguration
ReceivedMethodCalls
Undefined
VerificationDirector
VerificationExpectation
Mockery
AsMonologProcessor
A reusable attribute to help configure a class or a method as a processor.
WithMonologChannel
A reusable attribute to help configure a class as expecting a given logger channel.
DateTimeImmutable
Overrides default json encoding of date time objects
ErrorHandler
Monolog error handler
ChromePHPFormatter
Formats a log message according to the ChromePHP array format
ElasticaFormatter
Format a log message into an Elastica Document
ElasticsearchFormatter
Format a log message into an Elasticsearch record
FlowdockFormatter
formats the record to be used in the FlowdockHandler
FluentdFormatter
Class FluentdFormatter
GelfMessageFormatter
Serializes a log message to GELF
GoogleCloudLoggingFormatter
Encodes message information into JSON in a format compatible with Cloud logging.
HtmlFormatter
Formats incoming records into an HTML table
JsonFormatter
Encodes whatever record data is passed to it as json
LineFormatter
Formats incoming records into a one-line string
LogglyFormatter
Encodes message information into JSON in a format compatible with Loggly.
LogmaticFormatter
Encodes message information into JSON in a format compatible with Logmatic.
LogstashFormatter
Serializes a log message to Logstash Event Format
MongoDBFormatter
Formats a record for use with the MongoDBHandler.
NormalizerFormatter
Normalizes incoming records to remove objects/resources so it's easier to dump to various targets
ScalarFormatter
Formats data into an associative array of scalar (+ null) values.
SyslogFormatter
Serializes a log message according to RFC 5424
WildfireFormatter
Serializes a log message according to Wildfire's header requirements
AbstractHandler
Base Handler class providing basic level/bubble support
AbstractProcessingHandler
Base Handler class providing the Handler structure, including processors and formatters
AbstractSyslogHandler
Common syslog functionality
AmqpHandler
Base Handler class providing the Handler structure, including processors and formatters
BrowserConsoleHandler
Handler sending logs to browser's javascript console with no browser extension required
BufferHandler
Buffers all records until closing the handler and then pass them as batch.
ChromePHPHandler
Handler sending logs to the ChromePHP extension (http://www.chromephp.com/)
CouchDBHandler
CouchDB handler
CubeHandler
Logs to Cube.
DeduplicationHandler
Simple handler wrapper that deduplicates log records across multiple requests
DoctrineCouchDBHandler
CouchDB handler for Doctrine CouchDB ODM
DynamoDbHandler
Amazon DynamoDB handler (http://aws.amazon.com/dynamodb/)
ElasticaHandler
Elastic Search handler
ElasticsearchHandler
Elasticsearch handler
ErrorLogHandler
Stores to PHP error_log() handler.
FallbackGroupHandler
Forwards records to at most one handler
FilterHandler
Simple handler wrapper that filters records based on a list of levels
ChannelLevelActivationStrategy
Channel and Error level based monolog activation strategy. Allows to trigger activation based on level per channel. e.g. trigger activation on level 'ERROR' by default, except for records of the 'sql' channel; those should trigger activation on level 'WARN'.
ErrorLevelActivationStrategy
Error level based activation strategy.
FingersCrossedHandler
Buffers all records until a certain level is reached
FirePHPHandler
Simple FirePHP Handler (http://www.firephp.org/), which uses the Wildfire protocol.
FleepHookHandler
Sends logs to Fleep.io using Webhook integrations
FlowdockHandler
Sends notifications through the Flowdock push API
GelfHandler
Handler to send messages to a Graylog2 (http://www.graylog2.org) server
GroupHandler
Forwards records to multiple handlers
Handler
Base Handler class providing basic close() support as well as handleBatch
HandlerWrapper
This simple wrapper class can be used to extend handlers functionality.
IFTTTHandler
IFTTTHandler uses cURL to trigger IFTTT Maker actions
InsightOpsHandler
Inspired on LogEntriesHandler.
LogEntriesHandler
Stores to any socket - uses fsockopen() or pfsockopen().
LogglyHandler
Sends errors to Loggly.
LogmaticHandler
Stores to any socket - uses fsockopen() or pfsockopen().
MailHandler
Base class for all mail handlers
MandrillHandler
MandrillHandler uses cURL to send the emails to the Mandrill API
MissingExtensionException
Exception can be thrown if an extension for a handler is missing
MongoDBHandler
Logs to a MongoDB database.
NativeMailerHandler
NativeMailerHandler uses the mail() function to send the emails
NewRelicHandler
Class to record a log on a NewRelic application.
NoopHandler
No-op
NullHandler
Blackhole
OverflowHandler
Handler to only pass log messages when a certain threshold of number of messages is reached.
PHPConsoleHandler
Monolog handler for Google Chrome extension "PHP Console"
ProcessHandler
Stores to STDIN of any process, specified by a command.
PsrHandler
Proxies log messages to an existing PSR-3 compliant logger.
PushoverHandler
Sends notifications through the pushover api to mobile phones
RedisHandler
Logs to a Redis key using rpush
RedisPubSubHandler
Sends the message to a Redis Pub/Sub channel using PUBLISH
RollbarHandler
Sends errors to Rollbar
RotatingFileHandler
Stores logs to files that are rotated every day and a limited number of files are kept.
SamplingHandler
Sampling handler
SendGridHandler
SendGridHandler uses the SendGrid API v3 function to send Log emails, more information in https://www.twilio.com/docs/sendgrid/for-developers/sending-email/api-getting-started
SlackRecord
Slack record utility helping to log to Slack webhooks or API.
SlackHandler
Sends notifications through Slack API
SlackWebhookHandler
Sends notifications through Slack Webhooks
SocketHandler
Stores to any socket - uses fsockopen() or pfsockopen().
SqsHandler
Writes to any sqs queue.
StreamHandler
Stores to any stream resource
SymfonyMailerHandler
SymfonyMailerHandler uses Symfony's Mailer component to send the emails
SyslogHandler
Logs to syslog service.
UdpSocket
SyslogUdpHandler
A Handler for logging to a remote syslogd server.
TelegramBotHandler
Handler sends logs to Telegram using Telegram Bot API.
TestHandler
Used for testing purposes.
WhatFailureGroupHandler
Forwards records to multiple handlers suppressing failures of each handler and continuing through to give every handler a chance to succeed.
ZendMonitorHandler
Handler sending logs to Zend Monitor
JsonSerializableDateTimeImmutable
Overrides default json encoding of date time objects
Logger
Monolog log channel
LogRecord
Monolog log record
ClosureContextProcessor
Generates a context from a Closure if the Closure is the only value in the context
GitProcessor
Injects Git branch and Git commit SHA in all records
HostnameProcessor
Injects value of gethostname in all records
IntrospectionProcessor
Injects line/file:class/function where the log message came from
LoadAverageProcessor
Injects sys_getloadavg in all records @see https://www.php.net/manual/en/function.sys-getloadavg.php
MemoryPeakUsageProcessor
Injects memory_get_peak_usage in all records
MemoryProcessor
Some methods that are common for all memory processors
MemoryUsageProcessor
Injects memory_get_usage in all records
MercurialProcessor
Injects Hg branch and Hg revision number in all records
ProcessIdProcessor
Adds value of getmypid into records
PsrLogMessageProcessor
Processes a record's message according to PSR-3 rules
TagProcessor
Adds a tags array into record
UidProcessor
Adds a unique identifier into records
WebProcessor
Injects url/method and remote IP of the current web request in all records
Registry
Monolog log registry
SignalHandler
Monolog POSIX signal handler
MonologTestCase
Lets you easily generate log records and a dummy formatter for testing purposes
TestCase
Lets you easily generate log records and a dummy formatter for testing purposes
Utils
AstRuntime
Uses an external tree visitor to interpret an AST.
CompilerRuntime
Compiles JMESPath expressions to PHP source code and executes it.
DebugRuntime
Provides CLI debugging information for the AST and Compiler runtimes.
Env
Provides a simple environment based search.
FnDispatcher
Dispatches to named JMESPath functions using a single function that has the following signature:
Lexer
Tokenizes JMESPath expressions
Parser
JMESPath Pratt parser
SyntaxErrorException
Syntax errors raise this exception that gives context
TreeCompiler
Tree visitor used to compile JMESPath expressions into native PHP code.
TreeInterpreter
Tree visitor used to evaluates JMESPath AST expressions.
Utils
DeepCopy
CloneException
PropertyException
ChainableFilter
Defines a decorator filter that will not stop the chain of filters.
DoctrineCollectionFilter
DoctrineEmptyCollectionFilter
DoctrineProxyFilter
KeepFilter
ReplaceFilter
SetNullFilter
DoctrineProxyMatcher
PropertyMatcher
PropertyNameMatcher
PropertyTypeMatcher
Matches a property by its type.
ReflectionHelper
DateIntervalFilter
DatePeriodFilter
ReplaceFilter
ShallowCopyFilter
ArrayObjectFilter
In PHP 7.4 the storage of an ArrayObject isn't returned as ReflectionProperty. So we deep copy its array copy.
SplDoublyLinkedList
SplDoublyLinkedListFilter
TypeMatcher
LazyMessageFormatter
LazyMessageFormatter
AbstractReflectionMacro
AbstractReflectionMacro
LazyMacro
LazyMacro
LazyTranslator
LazyTranslator
AbstractTranslator
Carbon
A simple API extension for DateTime.
CarbonImmutable
A simple API extension for DateTimeImmutable.
CarbonInterval
A simple API extension for DateInterval.
CarbonPeriod
Substitution of DatePeriod with some modifications and many more features.
CarbonPeriodImmutable
Substitution of DatePeriod with some modifications and many more features.
CarbonTimeZone
Invoker
BadComparisonUnitException
BadFluentConstructorException
BadFluentSetterException
EndLessPeriodException
ImmutableException
InvalidCastException
InvalidDateException
InvalidFormatException
InvalidIntervalException
InvalidPeriodDateException
InvalidPeriodParameterException
InvalidTimeZoneException
InvalidTypeException
NotACarbonClassException
NotAPeriodException
NotLocaleAwareException
OutOfRangeException
ParseErrorException
UnitException
UnitNotConfiguredException
UnknownGetterException
UnknownMethodException
UnknownSetterException
UnknownUnitException
UnreachableException
Factory
A factory to generate Carbon instances with common settings.
FactoryImmutable
A factory to generate CarbonImmutable instances with common settings.
Language
ServiceProvider
MessageFormatterMapper
AbstractMacro
Macro
MacroExtension
Class MacroExtension.
MacroScanner
Translator
TranslatorImmutable
Context
AnyOf
Structure
Type
Expect
Schema generator.
Message
Processor
Schema validator.
ValidationException
Validation error.
ArgumentOutOfRangeException
The value is outside the allowed range.
InvalidStateException
The object is in a state that does not allow the requested operation.
NotImplementedException
The requested feature is not implemented.
NotSupportedException
The requested operation is not supported.
DeprecatedException
The requested feature is deprecated and no longer available.
MemberAccessException
Cannot access the requested class property or method.
IOException
Failed to read from or write to a file or stream.
FileNotFoundException
The requested file does not exist.
DirectoryNotFoundException
The requested directory does not exist.
InvalidArgumentException
The provided argument has invalid type or format.
OutOfRangeException
The requested array or collection index does not exist.
UnexpectedValueException
The returned value has unexpected type or format.
ShouldNotHappenException
Houston, we have a problem.
CachingIterator
Smarter caching iterator.
Mapper
ArrayHash
Provides objects to work as array.
ArrayList
Provides the base class for a generic list (items can be accessed by index).
Arrays
Array tools library.
Callback
PHP callable tools.
DateTime
DateTime.
ImageException
An error occurred while working with the image.
UnknownImageFileException
The image file is invalid or in an unsupported format.
JsonException
JSON encoding or decoding failed.
RegexpException
Regular expression pattern or execution failed.
AssertionException
Type validation failed. The value doesn't match the expected type constraints.
FileSystem
File system tool.
Finder
Finder allows searching through directory trees using iterator.
Floats
Floating-point numbers comparison.
Helpers
Html
HTML helper.
Image
Basic manipulation with images. Supported types are JPEG, PNG, GIF, WEBP, AVIF and BMP.
ImageColor
Represent RGB color (0..255) with opacity (0..1).
ImageType
Type of image file.
Iterables
Utilities for iterables.
Json
JSON encoder and decoder.
Paginator
Paginating math.
Random
Secure random string generator.
Reflection
PHP reflection helpers.
Strings
String tools library.
Type
PHP type reflection.
Validators
Validation utilities.
Class_
ClassConst
Declaration
Enum_
EnumCase
Function_
FunctionLike
Interface_
Method
Namespace_
Param
Property
Trait_
TraitUse
TraitUseAdaptation
Use_
BuilderFactory
Doc
Comment
ConstExprEvaluationException
ConstExprEvaluator
Evaluates constant expressions.
Error
Collecting
Error handler that collects all errors into an array.
Throwing
Error handler that handles all errors by throwing them.
JsonDecoder
Emulative
AsymmetricVisibilityTokenEmulator
AttributeEmulator
EnumTokenEmulator
ExplicitOctalEmulator
KeywordEmulator
MatchTokenEmulator
NullsafeTokenEmulator
PropertyTokenEmulator
ReadonlyFunctionTokenEmulator
ReadonlyTokenEmulator
ReverseEmulator
Reverses emulation direction of the inner emulator.
Lexer
Modifiers
Modifiers used (as a bit mask) by various flags subnodes, for example on classes, functions, properties and constants.
NameContext
Arg
ArrayItem
Attribute
AttributeGroup
ClosureUse
ComplexType
This is a base class for complex types, including nullable types and union types.
Const_
DeclareItem
Array_
ArrayDimFetch
ArrayItem
ArrowFunction
Assign
BitwiseAnd
BitwiseOr
BitwiseXor
Coalesce
Concat
Div
Minus
Mod
Mul
Plus
Pow
ShiftLeft
ShiftRight
AssignOp
AssignRef
BitwiseAnd
BitwiseOr
BitwiseXor
BooleanAnd
BooleanOr
Coalesce
Concat
Div
Equal
Greater
GreaterOrEqual
Identical
LogicalAnd
LogicalOr
LogicalXor
Minus
Mod
Mul
NotEqual
NotIdentical
Plus
Pow
ShiftLeft
ShiftRight
Smaller
SmallerOrEqual
Spaceship
BinaryOp
BitwiseNot
BooleanNot
CallLike
Array_
Bool_
Double
Int_
Object_
String_
Unset_
Cast
ClassConstFetch
Clone_
Closure
ClosureUse
ConstFetch
Empty_
Error
Error node used during parsing with error recovery.
ErrorSuppress
Eval_
Exit_
FuncCall
Include_
Instanceof_
Isset_
List_
Match_
MethodCall
New_
NullsafeMethodCall
NullsafePropertyFetch
PostDec
PostInc
PreDec
PreInc
Print_
PropertyFetch
ShellExec
StaticCall
StaticPropertyFetch
Ternary
Throw_
UnaryMinus
UnaryPlus
Variable
Yield_
YieldFrom
Expr
Identifier
Represents a non-namespaced name. Namespaced names are represented using Name nodes.
InterpolatedStringPart
IntersectionType
This is a base class for complex types, including nullable types and union types.
MatchArm
FullyQualified
Relative
Name
NullableType
This is a base class for complex types, including nullable types and union types.
Param
PropertyHook
PropertyItem
DNumber
Encapsed
EncapsedStringPart
Float_
Int_
InterpolatedString
LNumber
Class_
Dir
File
Function_
Line
Method
Namespace_
Property
Trait_
MagicConst
String_
Scalar
StaticVar
Block
Break_
Case_
Catch_
Class_
ClassConst
ClassLike
ClassMethod
Const_
Continue_
Declare_
DeclareDeclare
Do_
Echo_
Else_
ElseIf_
Enum_
EnumCase
Expression
Represents statements of type "expr;"
Finally_
For_
Foreach_
Function_
Global_
Goto_
GroupUse
HaltCompiler
If_
InlineHTML
Interface_
Label
Namespace_
Nop
Nop/empty statement (;).
Property
PropertyProperty
Return_
Static_
StaticVar
Switch_
Trait_
TraitUse
Alias
Precedence
TraitUseAdaptation
TryCatch
Unset_
Use_
UseUse
While_
Stmt
UnionType
This is a base class for complex types, including nullable types and union types.
UseItem
VariadicPlaceholder
Represents the "..." in "foo(...)" of the first-class callable syntax.
VarLikeIdentifier
Represents a name that is written in source code with a leading dollar, but is not a proper variable. The leading dollar is not stored as part of the name.
NodeAbstract
NodeDumper
NodeFinder
NodeTraverser
CloningVisitor
Visitor cloning all nodes and linking to the original nodes using an attribute.
CommentAnnotatingVisitor
FindingVisitor
This visitor can be used to find and collect all nodes satisfying some criterion determined by a filter callback.
FirstFindingVisitor
This visitor can be used to find the first node satisfying some criterion determined by a filter callback.
NameResolver
NodeConnectingVisitor
Visitor that connects a child node to its parent node as well as its sibling nodes.
ParentConnectingVisitor
Visitor that connects a child node to its parent node.
NodeVisitorAbstract
Php7
Php8
ParserAbstract
ParserFactory
PhpVersion
A PHP version, representing only the major and minor version components.
Standard
PrettyPrinterAbstract
Token
A PHP token. On PHP 8.0 this extends from PhpToken.
Anchor
BreakLine
Dd
Div
Dl
Dt
Hr
Li
Ol
Paragraph
Span
Ul
Color
TermwindServiceProvider
ElementCollectionException
InvalidApplicationNameException
InvalidEmailException
InvalidUrlException
ManifestDocumentException
ManifestDocumentLoadingException
ManifestDocumentMapperException
ManifestElementException
ManifestLoaderException
NoEmailAddressException
ManifestDocumentMapper
ManifestLoader
ManifestSerializer
Application
ApplicationName
Author
AuthorCollection
AuthorCollectionIterator
BundledComponent
BundledComponentCollection
BundledComponentCollectionIterator
CopyrightInformation
Email
Extension
Library
License
Manifest
PhpExtensionRequirement
PhpVersionRequirement
RequirementCollection
RequirementCollectionIterator
Type
Url
AuthorElement
AuthorElementCollection
BundlesElement
ComponentElement
ComponentElementCollection
ContainsElement
CopyrightElement
ElementCollection
ExtElement
ExtElementCollection
ExtensionElement
LicenseElement
ManifestDocument
ManifestElement
PhpElement
RequiresElement
PhpdocSingleLineVarFixer
Main implementation taken from kubawerlos/php-cs-fixer-customere-fixers Copyright (c) 2018 Kuba Werłos
BuildMetaData
AbstractVersionConstraint
AndVersionConstraintGroup
AnyVersionConstraint
ExactVersionConstraint
GreaterThanOrEqualToVersionConstraint
OrVersionConstraintGroup
SpecificMajorAndMinorVersionConstraint
SpecificMajorVersionConstraint
InvalidPreReleaseSuffixException
InvalidVersionException
NoBuildMetaDataException
NoPreReleaseSuffixException
UnsupportedVersionConstraintException
PreReleaseSuffix
Version
VersionConstraintParser
VersionConstraintValue
VersionNumber
BinaryComparison
Calculation
Category
DatabaseAbstract
DAverage
DCount
DCountA
DGet
DMax
DMin
DProduct
DStDev
DStDevP
DSum
DVar
DVarP
Database
DateTime
Constants
Current
Date
DateParts
DateValue
Days
Days360
Difference
Helpers
Month
NetworkDays
Time
TimeParts
TimeValue
Week
WorkDay
YearFrac
ArrayArgumentHelper
ArrayArgumentProcessor
BranchPruner
CyclicReferenceStack
FormattedNumber
Logger
StructuredReference
BesselI
BesselJ
BesselK
BesselY
BitWise
Compare
Complex
ComplexFunctions
ComplexOperations
Constants
ConvertBase
ConvertBinary
ConvertDecimal
ConvertHex
ConvertOctal
ConvertUOM
EngineeringValidations
Erf
ErfC
Engineering
Exception
ExceptionHandler
Amortization
CashFlowValidations
Cumulative
Interest
InterestAndPrincipal
Payments
Periodic
Single
NonPeriodic
Periodic
Constants
Coupons
Depreciation
Dollar
FinancialValidations
Helpers
InterestRate
AccruedInterest
Price
Rates
SecurityValidations
Yields
TreasuryBill
Financial
FormulaParser
PARTLY BASED ON: Copyright (c) 2007 E. W. Bachtal, Inc.
FormulaToken
PARTLY BASED ON: Copyright (c) 2007 E. W. Bachtal, Inc.
Functions
ErrorValue
ExcelError
Value
MakeMatrix
WildcardMatch
Boolean
Conditional
Operations
Logical
Address
ExcelMatch
Filter
Formula
Helpers
HLookup
Hyperlink
Indirect
Lookup
LookupBase
LookupRefValidations
Matrix
Offset
RowColumnInformation
Selection
Sort
Unique
VLookup
LookupRef
Absolute
Angle
Arabic
Base
Ceiling
Combinations
Exp
Factorial
Floor
Gcd
Helpers
IntClass
Lcm
Logarithms
MatrixFunctions
Operations
Random
Roman
Round
SeriesSum
Sign
Sqrt
Subtotal
Sum
SumSquares
Cosecant
Cosine
Cotangent
Secant
Sine
Tangent
Trunc
MathTrig
AggregateBase
Mean
Averages
Conditional
Confidence
Counts
Deviations
Beta
Binomial
ChiSquared
DistributionValidations
Exponential
F
Fisher
Gamma
GammaBase
HyperGeometric
LogNormal
NewtonRaphson
Normal
Poisson
StandardNormal
StudentT
Weibull
Maximum
MaxMinBase
Minimum
Percentiles
Permutations
Size
StandardDeviations
Standardize
StatisticalValidations
Trends
VarianceBase
Variances
Statistical
CaseConvert
CharacterConvert
Concatenate
Extract
Format
Helpers
Replace
Search
Text
Trim
TextData
Stack
Service
Web
AddressHelper
AdvancedValueBinder
Cell
CellAddress
CellRange
ColumnRange
Coordinate
Helper class to manipulate cell coordinates.
DataType
DataValidation
DataValidator
Validate a cell value according to its validation rules.
DefaultValueBinder
Hyperlink
IgnoredErrors
RowRange
StringValueBinder
CellReferenceHelper
Axis
Created by PhpStorm.
AxisText
Created by PhpStorm.
Chart
ChartColor
DataSeries
DataSeriesValues
Created by PhpStorm.
Exception
GridLines
Created by PhpStorm.
Layout
Legend
PlotArea
Properties
Created by PhpStorm.
JpGraph
Jpgraph is not oficially maintained in Composer, so the version there could be out of date. For that reason, all unit test requiring Jpgraph are skipped. So, do not measure code coverage for this class till that is fixed.
JpGraphRendererBase
Base class for different Jpgraph implementations as charts renderer.
MtJpGraphRenderer
Jpgraph is not officially maintained by Composer at packagist.org.
Title
TrendLine
Created by PhpStorm.
Cells
CellsFactory
SimpleCache1
This is the default implementation for in-memory cell collection.
SimpleCache3
This is the default implementation for in-memory cell collection.
Comment
DefinedName
Properties
Security
Exception
HashTable
Dimension
Downloader
Handler
Html
Sample
Helper class to be used in sample code.
Size
TextGrid
IOFactory
Factory to create readers and writers easily.
NamedFormula
NamedRange
BaseReader
Delimiter
Csv
DefaultReadFilter
Exception
PageSetup
Properties
Styles
Gnumeric
Html
AutoFilter
BaseLoader
DefinedNames
FormulaTranslator
PageSettings
Properties
Ods
XmlScanner
Slk
BIFF5
BIFF8
BuiltIn
Color
ConditionalFormatting
DataValidationHelper
ErrorCode
Escher
MD5
RC4
Border
CellAlignment
CellFont
FillPattern
Xls
AutoFilter
BaseParserClass
Chart
ColumnAndRowAttributes
ConditionalStyles
DataValidations
Hyperlinks
Namespaces
PageSetup
Properties
SharedFormula
SheetViewOptions
SheetViews
Styles
TableReader
Theme
WorkbookView
Xlsx
DataValidations
PageSettings
Properties
Alignment
Border
Fill
Font
NumberFormat
StyleBase
Style
Xml
Reader for SpreadsheetML, the XML schema for Microsoft Office Excel 2003.
ReferenceHelper
RichText
Run
TextElement
Settings
CodePage
Date
Drawing
SpContainer
SpgrContainer
DgContainer
Blip
BSE
BstoreContainer
DggContainer
Escher
File
Font
IntOrFloat
ChainedBlockStream
File
Class for creating File PPS's for OLE containers.
Root
Class for creating Root PPS's for OLE containers.
PPS
Class for creating PPS's for OLE containers.
OLE
OLE package base class.
OLERead
PasswordHasher
StringHelper
TimeZone
BestFit
ExponentialBestFit
LinearBestFit
LogarithmicBestFit
PolynomialBestFit
PowerBestFit
Trend
Xls
XMLWriter
Spreadsheet
Alignment
Border
Borders
Color
Conditional
CellMatcher
CellStyleAssessor
ConditionalDataBar
ConditionalDataBarExtension
ConditionalFormattingRuleExtension
ConditionalFormatValueObject
StyleMerger
Blanks
CellValue
DateValue
Duplicates
Errors
Expression
TextValue
WizardAbstract
Wizard
Fill
Font
BaseFormatter
DateFormatter
Formatter
FractionFormatter
NumberFormatter
PercentageFormatter
Accounting
Currency
Date
DateTime
DateTimeWizard
Duration
Locale
Number
NumberBase
Percentage
Scientific
Time
NumberFormat
Protection
RgbTint
Class to handle tint applied to color.
Style
Supervisor
Theme
Rule
Column
AutoFilter
AutoFit
BaseDrawing
CellIterator
Column
ColumnCellIterator
ColumnDimension
ColumnIterator
Dimension
Shadow
Drawing
HeaderFooter
<code> Header/Footer Formatting Syntax taken from Office Open XML Part 4 - Markup Language Reference, page 1970:.
HeaderFooterDrawing
Iterator
MemoryDrawing
PageBreak
PageMargins
PageSetup
<code> Paper size taken from Office Open XML Part 4 - Markup Language Reference, page 1988:.
Protection
Row
RowCellIterator
RowDimension
RowIterator
SheetView
Column
TableStyle
Table
Validations
Worksheet
BaseWriter
Csv
Exception
Html
AutoFilters
Comment
Style
Content
Formula
Meta
MetaInf
Mimetype
NamedExpressions
Settings
Styles
Thumbnails
WriterPart
Ods
Dompdf
Mpdf
Tcpdf
Pdf
BIFFwriter
CellDataValidation
ConditionalHelper
ErrorCode
Escher
Font
Parser
CellAlignment
CellBorder
CellFill
ColorMap
Workbook
Worksheet
Xf
Xls
AutoFilter
Chart
Comments
ContentTypes
DefinedNames
DocProps
Drawing
FunctionPrefix
Rels
RelsRibbon
RelsVBA
StringTable
Style
Table
Theme
Workbook
Worksheet
WriterPart
Xlsx
ZipStream0
ZipStream2
ZipStream3
LazyOption
None
Option
Some
CodeCoverage
Provides collection functionality for PHP code coverage information.
Selector
BranchAndPathCoverageNotSupportedException
DeadCodeDetectionNotSupportedException
DirectoryCouldNotBeCreatedException
FileCouldNotBeWrittenException
InvalidArgumentException
NoCodeCoverageDriverAvailableException
NoCodeCoverageDriverWithPathCoverageSupportAvailableException
ParserException
PathExistsButIsNotDirectoryException
PcovNotAvailableException
ReflectionException
ReportAlreadyFinalizedException
StaticAnalysisCacheNotConfiguredException
TestIdMissingException
UnintentionallyCoveredCodeException
WriteOperationFailedException
XdebugNotAvailableException
XdebugNotEnabledException
XmlException
Filter
Clover
Cobertura
Crap4j
Colors
CustomCssFile
Facade
PHP
Text
Thresholds
Facade
CacheWarmer
Known
Large
Medium
Small
TestSize
Unknown
Failure
Known
Success
TestStatus
Unknown
Version
Facade
ProcessControlExtensionNotLoadedException
TimeoutException
Invoker
InvalidArgumentException
RuntimeException
Template
Duration
NoActiveTimerException
TimeSinceStartOfRequestNotAvailableException
ResourceUsageFormatter
Timer
Finished
Started
EventCollection
EventCollectionIterator
AssertionFailed
AssertionSucceeded
ComparatorRegistered
AfterLastTestMethodCalled
AfterLastTestMethodErrored
AfterLastTestMethodFinished
AfterTestMethodCalled
AfterTestMethodErrored
AfterTestMethodFinished
BeforeFirstTestMethodCalled
BeforeFirstTestMethodErrored
BeforeFirstTestMethodFinished
BeforeTestMethodCalled
BeforeTestMethodErrored
BeforeTestMethodFinished
PostConditionCalled
PostConditionErrored
PostConditionFinished
PreConditionCalled
PreConditionErrored
PreConditionFinished
ConsideredRisky
DeprecationTriggered
ErrorTriggered
NoticeTriggered
PhpDeprecationTriggered
PhpNoticeTriggered
PhpunitDeprecationTriggered
PhpunitErrorTriggered
PhpunitWarningTriggered
PhpWarningTriggered
WarningTriggered
DataProviderMethodCalled
DataProviderMethodFinished
Finished
PreparationFailed
PreparationStarted
Prepared
Errored
Failed
MarkedIncomplete
Passed
Skipped
PrintedUnexpectedOutput
MockObjectCreated
MockObjectForAbstractClassCreated
MockObjectForIntersectionOfInterfacesCreated
MockObjectForTraitCreated
MockObjectFromWsdlCreated
PartialMockObjectCreated
TestProxyCreated
TestStubCreated
TestStubForIntersectionOfInterfacesCreated
BootstrapFinished
Configured
DeprecationTriggered
EventFacadeSealed
ExecutionAborted
ExecutionFinished
ExecutionStarted
ExtensionBootstrapped
ExtensionLoadedFromPhar
Finished
GarbageCollectionDisabled
GarbageCollectionEnabled
GarbageCollectionTriggered
Started
WarningTriggered
Filtered
Finished
Loaded
Skipped
Sorted
Started
EventAlreadyAssignedException
EventFacadeIsSealedException
InvalidArgumentException
InvalidEventException
InvalidSubscriberException
MapError
MoreThanOneDataSetFromDataProviderException
NoComparisonFailureException
NoDataSetFromDataProviderException
NoPreviousThrowableException
RuntimeException
SubscriberTypeAlreadyRegisteredException
UnknownEventException
UnknownEventTypeException
UnknownSubscriberException
UnknownSubscriberTypeException
ClassMethod
ComparisonFailure
OperatingSystem
PHP
PHPUnit
Runtime
Duration
GarbageCollectorStatus
HRTime
Info
MemoryUsage
Snapshot
Phpt
Test
TestCollection
TestCollectionIterator
DataFromDataProvider
DataFromTestDependency
TestData
TestDataCollection
TestDataCollectionIterator
TestDox
TestMethod
TestSuite
TestSuiteForTestClass
TestSuiteForTestMethodWithDataProvider
TestSuiteWithName
Throwable
Assert
After
AfterClass
BackupGlobals
BackupStaticProperties
Before
BeforeClass
CodeCoverageIgnore
CoversClass
CoversFunction
CoversNothing
DataProvider
DataProviderExternal
Depends
DependsExternal
DependsExternalUsingDeepClone
DependsExternalUsingShallowClone
DependsOnClass
DependsOnClassUsingDeepClone
DependsOnClassUsingShallowClone
DependsUsingDeepClone
DependsUsingShallowClone
DoesNotPerformAssertions
ExcludeGlobalVariableFromBackup
ExcludeStaticPropertyFromBackup
Group
IgnoreClassForCodeCoverage
IgnoreDeprecations
IgnoreFunctionForCodeCoverage
IgnoreMethodForCodeCoverage
Large
Medium
PostCondition
PreCondition
PreserveGlobalState
RequiresFunction
RequiresMethod
RequiresOperatingSystem
RequiresOperatingSystemFamily
RequiresPhp
RequiresPhpExtension
RequiresPhpunit
RequiresSetting
RunClassInSeparateProcess
RunInSeparateProcess
RunTestsInSeparateProcesses
Small
Test
TestDox
TestWith
TestWithJson
Ticket
UsesClass
UsesFunction
WithoutErrorHandler
IsFalse
IsTrue
Callback
Count
GreaterThan
IsEmpty
LessThan
SameSize
Constraint
IsEqual
IsEqualCanonicalizing
IsEqualIgnoringCase
IsEqualWithDelta
DirectoryExists
FileExists
IsReadable
IsWritable
IsAnything
IsIdentical
JsonMatches
IsFinite
IsInfinite
IsNan
ObjectEquals
ObjectHasProperty
BinaryOperator
LogicalAnd
LogicalNot
LogicalOr
LogicalXor
Operator
UnaryOperator
IsJson
RegularExpression
StringContains
StringEndsWith
StringEqualsStringIgnoringLineEndings
StringMatchesFormatDescription
StringStartsWith
ArrayHasKey
IsList
TraversableContains
TraversableContainsEqual
TraversableContainsIdentical
TraversableContainsOnly
IsInstanceOf
IsNull
IsType
NeverReturningMethodException
MockBuilder
InvocationMocker
TestCase
After
AfterClass
BackupGlobals
BackupStaticProperties
Before
BeforeClass
Covers
CoversClass
CoversDefaultClass
CoversFunction
CoversNothing
DataProvider
DependsOnClass
DependsOnMethod
DoesNotPerformAssertions
InvalidVersionRequirementException
NoVersionRequirementException
ExcludeGlobalVariableFromBackup
ExcludeStaticPropertyFromBackup
Group
IgnoreClassForCodeCoverage
IgnoreDeprecations
IgnoreFunctionForCodeCoverage
IgnoreMethodForCodeCoverage
Metadata
MetadataCollection
MetadataCollectionIterator
PostCondition
PreCondition
PreserveGlobalState
RequiresFunction
RequiresMethod
RequiresOperatingSystem
RequiresOperatingSystemFamily
RequiresPhp
RequiresPhpExtension
RequiresPhpunit
RequiresSetting
RunClassInSeparateProcess
RunInSeparateProcess
RunTestsInSeparateProcesses
Test
TestDox
TestWith
Uses
UsesClass
UsesDefaultClass
UsesFunction
ComparisonRequirement
ConstraintRequirement
Requirement
WithoutErrorHandler
Facade
ParameterCollection
Version
Builder
Configuration
Constant
ConstantCollection
ConstantCollectionIterator
Directory
DirectoryCollection
DirectoryCollectionIterator
ExtensionBootstrap
ExtensionBootstrapCollection
ExtensionBootstrapCollectionIterator
File
FileCollection
FileCollectionIterator
FilterDirectory
FilterDirectoryCollection
FilterDirectoryCollectionIterator
Group
GroupCollection
GroupCollectionIterator
IniSetting
IniSettingCollection
IniSettingCollectionIterator
Php
Source
TestDirectory
TestDirectoryCollection
TestDirectoryCollectionIterator
TestFile
TestFileCollection
TestFileCollectionIterator
TestSuite
TestSuiteCollection
TestSuiteCollectionIterator
Variable
VariableCollection
VariableCollectionIterator
UnexpectedOutputPrinter
ExcludeList
VersionComparisonOperator
AbstractLogger
This is a simple Logger implementation that other Loggers can inherit from.
InvalidArgumentException
LogLevel
Describes log levels.
NullLogger
This Logger can be used to avoid conditional log calls.
AbstractClassPass
The abstract class pass handles abstract classes and methods, complaining if there are too few or too many of either.
AssignThisVariablePass
Validate that the user input does not assign the `$this` variable.
CalledClassPass
The called class pass throws warnings for get_class() and get_called_class() outside a class context.
CallTimePassByReferencePass
Validate that the user did not use the call-time pass-by-reference that causes a fatal error.
CodeCleanerPass
A CodeCleaner pass is a PhpParser Node Visitor.
EmptyArrayDimFetchPass
Validate empty brackets are only used for assignment.
ExitPass
A CodeCleaner pass is a PhpParser Node Visitor.
FinalClassPass
The final class pass handles final classes.
FunctionContextPass
A CodeCleaner pass is a PhpParser Node Visitor.
FunctionReturnInWriteContextPass
Validate that the functions are used correctly.
ImplicitReturnPass
Add an implicit "return" to the last statement, provided it can be returned.
IssetPass
Code cleaner pass to ensure we only allow variables, array fetch and property fetch expressions in isset() calls.
LabelContextPass
CodeCleanerPass for label context.
LeavePsyshAlonePass
Validate that the user input does not reference the `$__psysh__` variable.
ListPass
Validate that the list assignment.
LoopContextPass
The loop context pass handles invalid `break` and `continue` statements.
MagicConstantsPass
Swap out __DIR__ and __FILE__ magic constants with our best guess?
NamespaceAwarePass
Abstract namespace-aware code cleaner pass.
NamespacePass
Provide implicit namespaces for subsequent execution.
NoReturnValue
A class used internally by CodeCleaner to represent input, such as non-expression statements, with no return value.
PassableByReferencePass
Validate that only variables (and variable-like things) are passed by reference.
RequirePass
Add runtime validation for `require` and `require_once` calls.
ReturnTypePass
Add runtime validation for return types.
StrictTypesPass
Provide implicit strict types declarations for for subsequent execution.
UseStatementPass
Provide implicit use statements for subsequent execution.
ValidClassNamePass
Validate that classes exist.
ValidConstructorPass
Validate that the constructor method is not static, and does not have a return type.
ValidFunctionNamePass
Validate that function calls will succeed.
CodeCleaner
A service to clean up user input, detect parse errors before they happen, and generally work around issues with the PHP code evaluation experience.
BufferCommand
Interact with the current code buffer.
ClearCommand
Clear the Psy Shell.
CodeArgumentParser
Class CodeArgumentParser.
Command
The Psy Shell base command.
DocCommand
Read the documentation for an object, class, constant, method or property.
DumpCommand
Dump an object or primitive.
EditCommand
The Psy Shell base command.
ExitCommand
Exit the Psy Shell.
HelpCommand
Help command.
HistoryCommand
Psy Shell history command.
ClassConstantEnumerator
Class Constant Enumerator class.
ClassEnumerator
Class Enumerator class.
ConstantEnumerator
Constant Enumerator class.
Enumerator
Abstract Enumerator class.
FunctionEnumerator
Function Enumerator class.
GlobalVariableEnumerator
Global Variable Enumerator class.
MethodEnumerator
Method Enumerator class.
PropertyEnumerator
Property Enumerator class.
VariableEnumerator
Variable Enumerator class.
ListCommand
List available local variables, object properties, etc.
ParseCommand
Parse PHP code and show the abstract syntax tree.
PsyVersionCommand
A dumb little command for printing out the current Psy Shell version.
ReflectingCommand
An abstract command with helpers for inspecting the current context.
ShowCommand
Show the code for an object, class, constant, method or property.
SudoCommand
Evaluate PHP code, bypassing visibility restrictions.
ThrowUpCommand
Throw an exception or error out of the Psy Shell.
TimeitVisitor
A node visitor for instrumenting code to be executed by the `timeit` command.
TimeitCommand
Class TimeitCommand.
TraceCommand
Show the current stack trace.
WhereamiCommand
Show the context of where you opened the debugger.
WtfCommand
Show the last uncaught exception.
ConfigPaths
A Psy Shell configuration path helper.
Configuration
The Psy Shell configuration.
Context
The Shell execution context.
BreakException
A break exception, used for halting the Psy Shell.
DeprecatedException
A DeprecatedException for Psy.
ErrorException
A custom error Exception for Psy with a formatted $message.
FatalErrorException
A "fatal error" Exception for Psy.
ParseErrorException
A "parse error" Exception for Psy.
RuntimeException
A RuntimeException for Psy.
ThrowUpException
A throw-up exception, used for throwing an exception out of the Psy Shell.
UnexpectedTargetException
A RuntimeException for Psy.
ExecutionClosure
The Psy Shell's execution scope.
AbstractListener
Abstract Execution Loop Listener class.
ProcessForker
An execution loop listener that forks the process before executing code.
RunkitReloader
A runkit-based code reloader, which is pretty much magic.
ExecutionLoopClosure
The Psy Shell's execution loop scope.
CodeFormatter
A pretty-printer for code.
DocblockFormatter
A pretty-printer for docblocks.
SignatureFormatter
An abstract representation of a function, class or property signature.
TraceFormatter
Output formatter for exception traces.
CodeArgument
An input argument for code.
FilterOptions
Parse, validate and match --grep, --insensitive and --invert command options.
ShellInput
A StringInput subclass specialized for code arguments.
SilentInput
A simple class used internally by PsySH to represent silent input.
PassthruPager
A passthrough pager is a no-op. It simply wraps a StreamOutput's stream and does nothing when the pager is closed.
ProcOutputPager
ProcOutputPager class.
ShellOutput
A ConsoleOutput subclass specifically for Psy Shell output.
Theme
An output Theme, which controls prompt strings, formatter styles, and compact output.
ParserFactory
Parser factory to abstract over PHP Parser library versions.
GNUReadline
A Readline interface implementation for GNU Readline.
AutocompleterAggregate
Class \Hoa\Console\Readline\Autocompleter\Aggregate.
AutocompleterPath
Class \Hoa\Console\Readline\Autocompleter\Path.
AutocompleterWord
Class \Hoa\Console\Readline\Autocompleter\Word.
Console
Class \Hoa\Console.
ConsoleCursor
Class \Hoa\Console\Cursor.
ConsoleException
Class \Hoa\Console\Exception.
ConsoleInput
Interface \Hoa\Console\Input.
ConsoleOutput
Class \Hoa\Console\Output.
ConsoleProcessus
Manipulate a processus as a stream.
ConsoleTput
Class \Hoa\Console\Tput.
ConsoleWindow
Allow to manipulate the window.
Event
Events are asynchronous at registration, anonymous at use (until we receive a bucket) and useful to largely spread data through components without any known connection between them.
EventBucket
This class is the object which is transmit through event channels.
EventException
Extending the `Hoa\Exception\Exception` class.
EventListener
A contrario of events, listeners are synchronous, identified at use and useful for close interactions between one or some components.
Exception
Each exception must extend `Hoa\Exception\Exception`.
ExceptionIdle
`Hoa\Exception\Idle` is the mother exception class of libraries. The only difference between `Hoa\Exception\Idle` and its direct children `Hoa\Exception` is that the latter fires events after beeing constructed.
File
Class \Hoa\File.
FileDirectory
Class \Hoa\File\Directory.
FileDoesNotExistException
Class \Hoa\File\Exception\FileDoesNotExist.
FileException
Class \Hoa\File\Exception.
FileFinder
Class \Hoa\File\Finder.
FileGeneric
Class \Hoa\File\Generic.
FileLink
Class \Hoa\File\Link.
FileLinkRead
Class \Hoa\File\Link\Read.
FileLinkReadWrite
Class \Hoa\File\Link\ReadWrite.
FileRead
Class \Hoa\File\Read.
FileReadWrite
Class \Hoa\File\ReadWrite.
IteratorFileSystem
Class \Hoa\Iterator\FileSystem.
IteratorRecursiveDirectory
Class \Hoa\Iterator\Recursive\Directory.
IteratorSplFileInfo
Class \Hoa\Iterator\SplFileInfo.
Protocol
Root of the `hoa://` protocol.
ProtocolException
Extends the `Hoa\Exception\Exception` class.
ProtocolNode
Abstract class for all `hoa://`'s nodes.
ProtocolNodeLibrary
The `hoa://Library/` node.
ProtocolWrapper
Stream wrapper for the `hoa://` protocol.
Readline
Class \Hoa\Console\Readline.
Stream
Class \Hoa\Stream.
_Protocol
Class \Hoa\Stream\_Protocol.
StreamContext
Class \Hoa\Stream\Context.
StreamException
Class \Hoa\Stream\Exception.
Ustring
This class represents a UTF-8 string.
Xcallable
Build a callable object, i.e. `function`, `class::method`, `object->method` or closure. They all have the same behaviour. This callable is an extension of native PHP callable (aka callback) to integrate Hoa's structures.
Libedit
A Libedit-based Readline implementation.
Transient
An array-based Readline emulation implementation.
Userland
Userland Readline implementation.
ReflectionConstant
Somehow the standard reflection library doesn't include constants.
ReflectionLanguageConstruct
A fake ReflectionFunction but for language constructs.
ReflectionLanguageConstructParameter
A fake ReflectionParameter but for language construct parameters.
ReflectionNamespace
A fake Reflector for namespaces.
Shell
The Psy Shell application.
SudoVisitor
A PHP Parser node visitor which rewrites property and method access to use the Psy\Sudo visibility bypass methods.
Sudo
Helpers for bypassing visibility restrictions, mostly used in code generated by the `sudo` command.
SuperglobalsEnv
Environment variables implementation via $_SERVER superglobal.
SystemEnv
Environment variables implementation via getenv().
AutoCompleter
A readline tab completion service.
AbstractContextAwareMatcher
An abstract tab completion Matcher which implements ContextAware.
AbstractDefaultParametersMatcher
An abstract tab completion Matcher which implements ContextAware.
AbstractMatcher
Abstract tab completion Matcher.
ClassAttributesMatcher
A class attribute tab completion Matcher.
ClassMethodDefaultParametersMatcher
An abstract tab completion Matcher which implements ContextAware.
ClassMethodsMatcher
A class method tab completion Matcher.
ClassNamesMatcher
A class name tab completion Matcher.
CommandsMatcher
A Psy Command tab completion Matcher.
ConstantsMatcher
A constant name tab completion Matcher.
FunctionDefaultParametersMatcher
An abstract tab completion Matcher which implements ContextAware.
FunctionsMatcher
A function name tab completion Matcher.
KeywordsMatcher
A PHP keyword tab completion Matcher.
MongoClientMatcher
A MongoDB Client tab completion Matcher.
MongoDatabaseMatcher
A MongoDB tab completion Matcher.
ObjectAttributesMatcher
An object attribute tab completion Matcher.
ObjectMethodDefaultParametersMatcher
An abstract tab completion Matcher which implements ContextAware.
ObjectMethodsMatcher
An object method tab completion Matcher.
VariablesMatcher
A variable name tab completion Matcher.
Docblock
A docblock representation.
Json
A static class to wrap JSON encoding/decoding with PsySH's default options.
Mirror
A utility class for getting Reflectors.
Str
String utility methods.
Cloner
A PsySH-specialized VarCloner.
Dumper
A PsySH-specialized CliDumper.
Presenter
A Presenter service.
CurlDownloader
Factory
FileDownloader
GitHubChecker
Installer
IntervalChecker
NoopChecker
A version checker stub which always thinks the current version is up to date.
SelfUpdate
Self update command.
AbstractArray
This class provides a basic implementation of `ArrayInterface`, to minimize the effort required to implement this interface.
AbstractCollection
This class provides a basic implementation of `CollectionInterface`, to minimize the effort required to implement this interface
AbstractSet
This class contains the basic implementation of a collection that does not allow duplicated values (a set), to minimize the effort required to implement this specific type of collection.
Collection
A collection represents a group of objects.
DoubleEndedQueue
This class provides a basic implementation of `DoubleEndedQueueInterface`, to minimize the effort required to implement this interface.
CollectionMismatchException
Thrown when attempting to operate on collections of differing types.
InvalidArgumentException
Thrown to indicate an argument is not of the expected type.
InvalidPropertyOrMethod
Thrown when attempting to evaluate a property, method, or array key that doesn't exist on an element or cannot otherwise be evaluated in the current context.
NoSuchElementException
Thrown when attempting to access an element that does not exist.
OutOfBoundsException
Thrown when attempting to access an element out of the range of the collection.
UnsupportedOperationException
Thrown to indicate that the requested operation is not supported.
GenericArray
`GenericArray` represents a standard array object.
AbstractMap
This class provides a basic implementation of `MapInterface`, to minimize the effort required to implement this interface.
AbstractTypedMap
This class provides a basic implementation of `TypedMapInterface`, to minimize the effort required to implement this interface.
AssociativeArrayMap
`AssociativeArrayMap` represents a standard associative array object.
NamedParameterMap
`NamedParameterMap` represents a mapping of values to a set of named keys that may optionally be typed
TypedMap
A `TypedMap` represents a map of elements where key and value are typed.
Queue
This class provides a basic implementation of `QueueInterface`, to minimize the effort required to implement this interface.
Set
A set is a collection that contains no duplicate elements.
BinaryUtils
Provides binary math utilities
BuilderCollection
A collection of UuidBuilderInterface objects
DefaultUuidBuilder
UuidBuilder builds instances of RFC 4122 UUIDs
DegradedUuidBuilder
FallbackBuilder
FallbackBuilder builds a UUID by stepping through a list of UUID builders until a UUID can be constructed without exceptions
GuidStringCodec
GuidStringCodec encodes and decodes globally unique identifiers (GUID)
OrderedTimeCodec
OrderedTimeCodec encodes and decodes a UUID, optimizing the byte order for more efficient storage
StringCodec
StringCodec encodes and decodes RFC 4122 UUIDs
TimestampFirstCombCodec
TimestampFirstCombCodec encodes and decodes COMBs, with the timestamp as the first 48 bits
TimestampLastCombCodec
TimestampLastCombCodec encodes and decodes COMBs, with the timestamp as the last 48 bits
BigNumberConverter
Previously used to integrate moontoast/math as a bignum arithmetic library, BigNumberConverter is deprecated in favor of GenericNumberConverter
DegradedNumberConverter
Previously used to integrate moontoast/math as a bignum arithmetic library, BigNumberConverter is deprecated in favor of GenericNumberConverter
GenericNumberConverter
GenericNumberConverter uses the provided calculator to convert decimal numbers to and from hexadecimal values
BigNumberTimeConverter
Previously used to integrate moontoast/math as a bignum arithmetic library, BigNumberTimeConverter is deprecated in favor of GenericTimeConverter
DegradedTimeConverter
Previously used to integrate moontoast/math as a bignum arithmetic library, BigNumberTimeConverter is deprecated in favor of GenericTimeConverter
GenericTimeConverter
GenericTimeConverter uses the provided calculator to calculate and convert time values
PhpTimeConverter
PhpTimeConverter uses built-in PHP functions and standard math operations available to the PHP programming language to provide facilities for converting parts of time into representations that may be used in UUIDs
UnixTimeConverter
UnixTimeConverter converts Unix Epoch timestamps to/from hexadecimal values consisting of milliseconds elapsed since the Unix Epoch
DegradedUuid
Uuid provides constants and static methods for working with and generating UUIDs
BuilderNotFoundException
Thrown to indicate that no suitable builder could be found
DateTimeException
Thrown to indicate that the PHP DateTime extension encountered an exception/error
DceSecurityException
Thrown to indicate an exception occurred while dealing with DCE Security (version 2) UUIDs
InvalidArgumentException
Thrown to indicate that the argument received is not valid
InvalidBytesException
Thrown to indicate that the bytes being operated on are invalid in some way
InvalidUuidStringException
Thrown to indicate that the string received is not a valid UUID
NameException
Thrown to indicate that an error occurred while attempting to hash a namespace and name
NodeException
Thrown to indicate that attempting to fetch or create a node ID encountered an error
RandomSourceException
Thrown to indicate that the source of random data encountered an error
TimeSourceException
Thrown to indicate that the source of time encountered an error
UnableToBuildUuidException
Thrown to indicate a builder is unable to build a UUID
UnsupportedOperationException
Thrown to indicate that the requested operation is not supported
FeatureSet
FeatureSet detects and exposes available features in the current environment
CombGenerator
CombGenerator generates COMBs (combined UUID/timestamp)
DceSecurityGenerator
DceSecurityGenerator generates strings of binary data based on a local domain, local identifier, node ID, clock sequence, and the current time
DefaultNameGenerator
DefaultNameGenerator generates strings of binary data based on a namespace, name, and hashing algorithm
DefaultTimeGenerator
DefaultTimeGenerator generates strings of binary data based on a node ID, clock sequence, and the current time
NameGeneratorFactory
NameGeneratorFactory retrieves a default name generator, based on the environment
PeclUuidNameGenerator
PeclUuidNameGenerator generates strings of binary data from a namespace and a name, using ext-uuid
PeclUuidRandomGenerator
PeclUuidRandomGenerator generates strings of random binary data using ext-uuid
PeclUuidTimeGenerator
PeclUuidTimeGenerator generates strings of binary data for time-base UUIDs, using ext-uuid
RandomBytesGenerator
RandomBytesGenerator generates strings of random binary data using the built-in `random_bytes()` PHP function
RandomGeneratorFactory
RandomGeneratorFactory retrieves a default random generator, based on the environment
RandomLibAdapter
RandomLibAdapter generates strings of random binary data using the paragonie/random-lib library
TimeGeneratorFactory
TimeGeneratorFactory retrieves a default time generator, based on the environment
UnixTimeGenerator
UnixTimeGenerator generates bytes that combine a 48-bit timestamp in milliseconds since the Unix Epoch with 80 random bits
Fields
GUIDs are comprised of a set of named fields, according to RFC 4122
Guid
Guid represents a UUID with "native" (little-endian) byte order
GuidBuilder
GuidBuilder builds instances of Guid
BrickMathCalculator
A calculator using the brick/math library for arbitrary-precision arithmetic
RoundingMode
Specifies a rounding behavior for numerical operations capable of discarding precision.
Fields
Nonstandard UUID fields do not conform to the RFC 4122 standard
Uuid
Nonstandard\Uuid is a UUID that doesn't conform to RFC 4122
UuidBuilder
Nonstandard\UuidBuilder builds instances of Nonstandard\Uuid
UuidV6
Reordered time, or version 6, UUIDs include timestamp, clock sequence, and node values that are combined into a 128-bit unsigned integer
SystemDceSecurityProvider
SystemDceSecurityProvider retrieves the user or group identifiers from the system
FallbackNodeProvider
FallbackNodeProvider retrieves the system node ID by stepping through a list of providers until a node ID can be obtained
NodeProviderCollection
A collection of NodeProviderInterface objects
RandomNodeProvider
RandomNodeProvider generates a random node ID
StaticNodeProvider
StaticNodeProvider provides a static node value with the multicast bit set
SystemNodeProvider
SystemNodeProvider retrieves the system node ID, if possible
FixedTimeProvider
FixedTimeProvider uses a known time to provide the time
SystemTimeProvider
SystemTimeProvider retrieves the current time using built-in PHP functions
Fields
RFC 4122 variant UUIDs are comprised of a set of named fields
MaxUuid
The max UUID is special form of UUID that is specified to have all 128 bits set to one
NilUuid
The nil UUID is special form of UUID that is specified to have all 128 bits set to zero
UuidBuilder
UuidBuilder builds instances of RFC 4122 UUIDs
UuidV1
Gregorian time, or version 1, UUIDs include timestamp, clock sequence, and node values that are combined into a 128-bit unsigned integer
UuidV2
DCE Security version, or version 2, UUIDs include local domain identifier, local ID for the specified domain, and node values that are combined into a 128-bit unsigned integer
UuidV3
Version 3 UUIDs are named-based, using combination of a namespace and name that are hashed into a 128-bit unsigned integer using MD5
UuidV4
Random, or version 4, UUIDs are randomly or pseudo-randomly generated 128-bit integers
UuidV5
Version 5 UUIDs are named-based, using combination of a namespace and name that are hashed into a 128-bit unsigned integer using SHA1
UuidV6
Reordered time, or version 6, UUIDs include timestamp, clock sequence, and node values that are combined into a 128-bit unsigned integer
UuidV7
Unix Epoch time, or version 7, UUIDs include a timestamp in milliseconds since the Unix Epoch, along with random bytes
UuidV8
Version 8, Custom UUIDs provide an RFC 4122 compatible format for experimental or vendor-specific uses
Validator
Rfc4122\Validator validates strings as UUIDs of the RFC 4122 variant
Decimal
A value object representing a decimal
Hexadecimal
A value object representing a hexadecimal number
Integer
A value object representing an integer
Time
A value object representing a timestamp
Uuid
Uuid provides constants and static methods for working with and generating UUIDs
UuidFactory
GenericValidator
GenericValidator validates strings as UUIDs of any variant
Abstraction
Base class for all Nodes.
Expression
Base class for all Nodes.
Literal
Base class for all Nodes.
Variable
Base class for all Nodes.
Abstraction
Named
| 1 | {?list} ?list=red,green,blue | {name}=(?:\w+(?:,\w+?)*)* | 2 | {?list*} ?list=red&list=green&list=blue | {name}+=(?:{$value}+(?:{sep}{name}+={$value}*))* | 3 | {?keys} ?keys=semi,%3B,dot,.,comma,%2C | (same as 1) | 4 | {?keys*} ?semi=%3B&dot=.&comma=%2C | (same as 2) | 5 | {?list*} ?list[]=red&list[]=green&list[]=blue | {name[]}+=(?:{$value}+(?:{sep}{name[]}+={$value}*))*.
UnNamed
| 1 | {/list} /red,green,blue | {$value}*(?:,{$value}+)* | 2 | {/list*} /red/green/blue | {$value}+(?:{$sep}{$value}+)* | 3 | {/keys} /semi,%3B,dot,.,comma,%2C | /(\w+,?)+ | 4 | {/keys*} /semi=%3B/dot=./comma=%2C | /(?:\w+=\w+/?)*.
Parser
UriTemplate
Future compatibility.
UriTemplate
URI Template.
ParserTest
UriTemplateTest
URI Template
AmbiguousOptionException
OptionDoesNotAllowArgumentException
RequiredOptionArgumentMissingException
UnknownOptionException
Parser
ClassMethodUnit
ClassUnit
CodeUnit
CodeUnitCollection
CodeUnitCollectionIterator
InvalidCodeUnitException
NoTraitException
ReflectionException
FileUnit
FunctionUnit
InterfaceMethodUnit
InterfaceUnit
Mapper
TraitMethodUnit
TraitUnit
Wizard
ArrayComparator
Arrays are equal if they contain the same key-value pairs.
Comparator
ComparisonFailure
DateTimeComparator
Arrays are equal if they contain the same key-value pairs.
DOMNodeComparator
Arrays are equal if they contain the same key-value pairs.
ExceptionComparator
Compares Exception instances for equality.
RuntimeException
Factory
MockObjectComparator
Compares PHPUnit\Framework\MockObject\MockObject instances for equality.
NumericComparator
Compares scalar or NULL values for equality.
ObjectComparator
Arrays are equal if they contain the same key-value pairs.
ResourceComparator
ScalarComparator
Compares scalar or NULL values for equality.
SplObjectStorageComparator
TypeComparator
Calculator
Complexity
ComplexityCollection
ComplexityCollectionIterator
RuntimeException
ComplexityCalculatingVisitor
CyclomaticComplexityCalculatingVisitor
Chunk
Diff
Differ
ConfigurationException
InvalidArgumentException
Line
MemoryEfficientLongestCommonSubsequenceCalculator
AbstractChunkOutputBuilder
DiffOnlyOutputBuilder
Builds a diff string representation in a loose unified diff format listing only changes lines. Does not include line numbers.
StrictUnifiedDiffOutputBuilder
Strict Unified diff output builder.
UnifiedDiffOutputBuilder
Builds a diff string representation in unified diff format in chunks.
Parser
Unified diff parser.
TimeEfficientLongestCommonSubsequenceCalculator
Console
Runtime
Exporter
CodeExporter
RuntimeException
ExcludeList
Restorer
Snapshot
A snapshot of global state.
Counter
IllogicalValuesException
NegativeValueException
RuntimeException
LineCountingVisitor
LinesOfCode
Enumerator
ObjectReflector
Context
RuntimeException
Parameter
ReflectionMapper
CallableType
FalseType
GenericObjectType
IntersectionType
IterableType
MixedType
NeverType
NullType
ObjectType
SimpleType
StaticType
TrueType
Type
UnionType
UnknownType
VoidType
TypeName
Version
ArgumentReducers
ProvidedArgument
ReduceArgumentPayloadAction
ReduceArgumentsAction
ReducedArgument
TruncatedReducedArgument
UnReducedArgument
VariadicReducedArgument
ArrayArgumentReducer
BaseTypeArgumentReducer
ClosureArgumentReducer
DateTimeArgumentReducer
DateTimeZoneArgumentReducer
EnumArgumentReducer
MinimalArrayArgumentReducer
SensitiveParameterArrayReducer
StdClassArgumentReducer
StringableArgumentReducer
SymphonyRequestArgumentReducer
Backtrace
CodeSnippet
FileSnippetProvider
LaravelSerializableClosureSnippetProvider
NullSnippetProvider
Frame
BaseSolution
DummyCache
OpenAiPromptViewModel
OpenAiSolution
OpenAiSolutionProvider
OpenAiSolutionResponse
BadMethodCallSolutionProvider
MergeConflictSolutionProvider
SolutionProviderRepository
UndefinedPropertySolutionProvider
SolutionTransformer
SuggestCorrectVariableNameSolution
SuggestImportSolution
GenerateAppKeySolution
LivewireDiscoverSolution
MakeViewVariableOptionalSolution
RunMigrationsSolution
DefaultDbNameSolutionProvider
GenericLaravelExceptionSolutionProvider
IncorrectValetDbCredentialsSolutionProvider
InvalidRouteActionSolutionProvider
LazyLoadingViolationSolutionProvider
MissingAppKeySolutionProvider
MissingColumnSolutionProvider
MissingImportSolutionProvider
MissingLivewireComponentSolutionProvider
MissingMixManifestSolutionProvider
MissingViteManifestSolutionProvider
OpenAiSolutionProvider
RouteNotDefinedSolutionProvider
RunningLaravelDuskInProductionProvider
SailNetworkSolutionProvider
SolutionProviderRepository
TableNotFoundSolutionProvider
UndefinedLivewireMethodSolutionProvider
UndefinedLivewirePropertySolutionProvider
UndefinedViewVariableSolutionProvider
UnknownMariadbCollationSolutionProvider
UnknownMysql8CollationSolutionProvider
UnknownValidationSolutionProvider
ViewNotFoundSolutionProvider
SuggestCorrectVariableNameSolution
SuggestImportSolution
SuggestLivewireMethodNameSolution
SuggestLivewirePropertyNameSolution
SuggestUsingCorrectDbNameSolution
SuggestUsingMariadbDatabaseSolution
SuggestUsingMysql8DatabaseSolution
UseDefaultValetDbCredentialsSolution
StringComparator
BaseSolution
DiscoverSolutionProviders
SolutionProviderRepository
BadMethodCallSolutionProvider
DefaultDbNameSolutionProvider
GenericLaravelExceptionSolutionProvider
IncorrectValetDbCredentialsSolutionProvider
InvalidRouteActionSolutionProvider
LazyLoadingViolationSolutionProvider
MissingAppKeySolutionProvider
MissingColumnSolutionProvider
MissingImportSolutionProvider
MissingLivewireComponentSolutionProvider
MissingMixManifestSolutionProvider
MissingViteManifestSolutionProvider
OpenAiSolutionProvider
RouteNotDefinedSolutionProvider
RunningLaravelDuskInProductionProvider
SailNetworkSolutionProvider
TableNotFoundSolutionProvider
UndefinedLivewireMethodSolutionProvider
UndefinedLivewirePropertySolutionProvider
UndefinedViewVariableSolutionProvider
UnknownMariadbCollationSolutionProvider
UnknownMysql8CollationSolutionProvider
UnknownValidationSolutionProvider
ViewNotFoundSolutionProvider
MergeConflictSolutionProvider
UndefinedPropertySolutionProvider
GenerateAppKeySolution
LivewireDiscoverSolution
MakeViewVariableOptionalSolution
RunMigrationsSolution
SuggestLivewireMethodNameSolution
SuggestLivewirePropertyNameSolution
SuggestUsingCorrectDbNameSolution
SuggestUsingMariadbDatabaseSolution
SuggestUsingMysql8DatabaseSolution
UseDefaultValetDbCredentialsSolution
DummyCache
OpenAiPromptViewModel
OpenAiSolution
OpenAiSolutionProvider
OpenAiSolutionResponse
SolutionTransformer
SuggestCorrectVariableNameSolution
SuggestImportSolution
AiPromptRenderer
ComposerClassMap
FakeComposer
LaravelVersion
LivewireComponentParser
StringComparator
Api
BaseContextProviderDetector
ConsoleContextProvider
RequestContextProvider
MessageLevels
OverriddenGrouping
Flare
AddDocumentationLinks
AddEnvironmentInformation
AddGitInformation
AddGlows
AddNotifierName
AddSolutions
CensorRequestBodyFields
CensorRequestHeaders
RemoveRequestIp
Frame
Glow
GlowRecorder
Client
BadResponse
BadResponseCode
InvalidData
MissingParameter
NotFound
Response
Report
ReportSolution
PhpStackFrameArgumentsFixer
SystemTime
AbstractTruncationStrategy
ReportTrimmer
TrimContextItemsStrategy
TrimStackFrameArgumentsStrategy
TrimStringsStrategy
View
FileConfigManager
IgnitionConfig
ErrorPageViewModel
Renderer
Ignition
CollectionArgumentReducer
ModelArgumentReducer
SolutionMakeCommand
Base class for all commands.
SolutionProviderMakeCommand
Base class for all commands.
TestCommand
Base class for all commands.
LaravelConsoleContextProvider
LaravelContextProviderDetector
LaravelLivewireRequestContextProvider
LaravelRequestContextProvider
CannotExecuteSolutionForNonLocalIp
HttpException.
InvalidConfig
ViewException
ViewExceptionWithSolution
Flare
AddContext
AddDumps
AddEnvironmentInformation
AddExceptionHandledStatus
AddExceptionInformation
AddJobs
AddLogs
AddNotifierName
AddQueries
ExecuteSolutionController
HealthCheckController
UpdateConfigController
RunnableSolutionsEnabled
ExecuteSolutionRequest
Request represents an HTTP request.
UpdateConfigRequest
Request represents an HTTP request.
IgnitionServiceProvider
Dump
DumpHandler
DumpRecorder
HtmlDumper
HtmlDumper dumps variables as HTML.
MultiDumpHandler
JobRecorder
LogMessage
LogRecorder
Query
QueryRecorder
ErrorPageRenderer
IgnitionExceptionRenderer
LaravelSolutionTransformer
FlareLogHandler
Base Handler class providing the Handler structure, including processors and formatters
LaravelDocumentationLinkFinder
LaravelVersion
RunnableSolutionsGuard
SentReports
BladeSourceMapCompiler
ViewExceptionMapper
AbstractAdapter
ApcuAdapter
ArrayAdapter
An in-memory cache storage.
ChainAdapter
Chains several adapters together.
CouchbaseBucketAdapter
CouchbaseCollectionAdapter
DoctrineDbalAdapter
FilesystemAdapter
FilesystemTagAwareAdapter
Stores tag id <> cache id relationship as a symlink, and lookup on invalidation calls.
MemcachedAdapter
NullAdapter
ParameterNormalizer
PdoAdapter
PhpArrayAdapter
Caches items at warm up time using a PHP array that is stored in shared memory by OPCache since PHP 7.0.
PhpFilesAdapter
ProxyAdapter
Psr16Adapter
Turns a PSR-16 cache into a PSR-6 one.
RedisAdapter
RedisTagAwareAdapter
Stores tag id <> cache id relationship as a Redis Set.
TagAwareAdapter
Implements simple and robust tag-based invalidation suitable for use with volatile caches.
TraceableAdapter
An adapter that collects data about all cache calls.
TraceableTagAwareAdapter
An adapter that collects data about all cache calls.
CacheItem
CacheDataCollector
DataCollector.
CacheCollectorPass
Inject a data collector to all the cache services to be able to get detailed statistics.
CachePoolClearerPass
CachePoolPass
CachePoolPrunerPass
BadMethodCallException
CacheException
InvalidArgumentException
LogicException
LockRegistry
LockRegistry is used internally by existing adapters to protect against cache stampede.
DefaultMarshaller
Serializes/unserializes values using igbinary_serialize() if available, serialize() otherwise.
DeflateMarshaller
Compresses values using gzdeflate().
SodiumMarshaller
Encrypt/decrypt values using Libsodium.
TagAwareMarshaller
A marshaller optimized for data structures generated by AbstractTagAwareAdapter.
EarlyExpirationDispatcher
Sends the computation of cached values to a message bus.
EarlyExpirationHandler
Computes cached values sent to a message bus.
EarlyExpirationMessage
Conveys a cached value that needs to be computed.
Psr16Cache
Turns a PSR-6 cache into a PSR-16 one.
Application
An Application is the container for a collection of commands.
AsCommand
Service tag to autoconfigure commands.
GithubActionReporter
Utility class for Github actions.
Color
Command
Base class for all commands.
CompleteCommand
Responsible for providing the values to the shell completion.
DumpCompletionCommand
Dumps the completion script for the current shell.
HelpCommand
HelpCommand displays the help for a given command.
LazyCommand
Base class for all commands.
ListCommand
ListCommand displays the list of all available commands for the application.
ContainerCommandLoader
Loads commands from a PSR-11 container.
FactoryCommandLoader
A simple command loader using factories to instantiate commands lazily.
CompletionInput
An input specialized for shell completion.
CompletionSuggestions
Stores all completion suggestions for the current input.
BashCompletionOutput
FishCompletionOutput
ZshCompletionOutput
Suggestion
Represents a single suggested value.
ConsoleEvents
Contains all events dispatched by an Application.
Cursor
AddConsoleCommandPass
Registers console commands.
ReStructuredTextDescriptor
ConsoleCommandEvent
Allows to do things before the command is executed, like skipping the command or executing code before the command is going to be executed.
ConsoleErrorEvent
Allows to handle throwables thrown while running a command.
ConsoleEvent
Allows to inspect input and output of a command.
ConsoleSignalEvent
Allows to inspect input and output of a command.
ConsoleTerminateEvent
Allows to manipulate the exit code of a command after its execution.
ErrorListener
CommandNotFoundException
Represents an incorrect command name typed in the console.
InvalidArgumentException
InvalidOptionException
Represents an incorrect option name or value typed in the console.
LogicException
MissingInputException
Represents failure to read input from stdin.
NamespaceNotFoundException
Represents an incorrect namespace typed in the console.
RunCommandFailedException
RuntimeException
NullOutputFormatter
NullOutputFormatterStyle
OutputFormatter
Formatter class for console output.
OutputFormatterStyle
Formatter style class for defining styles.
OutputFormatterStyleStack
DebugFormatterHelper
Helps outputting debug information when running an external program from a command.
DescriptorHelper
This class adds helper method to describe objects in various formats.
Dumper
FormatterHelper
The Formatter class provides helpers to format messages.
Helper
Helper is the base class for all helper classes.
HelperSet
HelperSet represents a set of helpers to be used with a command.
InputAwareHelper
An implementation of InputAwareInterface for Helpers.
OutputWrapper
Simple output wrapper for "tagged outputs" instead of wordwrap(). This solution is based on a StackOverflow answer: https://stackoverflow.com/a/20434776/1476819 from user557597 (alias SLN).
ProcessHelper
The ProcessHelper class provides helpers to run external processes.
ProgressBar
The ProgressBar provides helpers to display progress output.
ProgressIndicator
QuestionHelper
The QuestionHelper class provides helpers to interact with the user.
SymfonyQuestionHelper
Symfony Style Guide compliant question helper.
Table
Provides helpers to display a table.
TableCell
TableCellStyle
TableSeparator
Marks a row as being a separator.
TableStyle
Defines the styles for a Table.
ArgvInput
ArgvInput represents an input coming from the CLI arguments.
ArrayInput
ArrayInput represents an input provided as an array.
Input
Input is the base class for all concrete Input classes.
InputArgument
Represents a command line argument.
InputDefinition
A InputDefinition represents a set of valid command line arguments and options.
InputOption
Represents a command line option.
StringInput
StringInput represents an input provided as a string.
ConsoleLogger
PSR-3 compliant console logger.
RunCommandContext
RunCommandMessage
RunCommandMessageHandler
BufferedOutput
Base class for output classes.
ConsoleOutput
ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.
ConsoleSectionOutput
StreamOutput writes the output to a given stream.
NullOutput
NullOutput suppresses all output.
Output
Base class for output classes.
StreamOutput
StreamOutput writes the output to a given stream.
TrimmedBufferOutput
A BufferedOutput that keeps only the last N chars.
ChoiceQuestion
Represents a choice question.
ConfirmationQuestion
Represents a yes/no question.
Question
Represents a Question.
SignalMap
SignalRegistry
SingleCommandApplication
Base class for all commands.
OutputStyle
Decorates output to add console style guide helpers.
SymfonyStyle
Output decorator helpers for the Symfony Style Guide.
Terminal
ApplicationTester
Eases the testing of console applications.
CommandCompletionTester
Eases the testing of command completion.
CommandTester
Eases the testing of console commands.
CommandIsSuccessful
CssSelectorConverter
CssSelectorConverter is the main entry point of the component and can convert CSS selectors to XPath expressions.
ExpressionErrorException
ParseException is thrown when a CSS selector syntax is not valid.
InternalErrorException
ParseException is thrown when a CSS selector syntax is not valid.
ParseException
ParseException is thrown when a CSS selector syntax is not valid.
SyntaxErrorException
ParseException is thrown when a CSS selector syntax is not valid.
BufferingLogger
A buffering logger that stacks logs for later.
Debug
Registers all the debug tools.
DebugClassLoader
Autoloader checking if the class is really defined in the file found.
ClassNotFoundError
FatalError
OutOfMemoryError
UndefinedFunctionError
UndefinedMethodError
ClassNotFoundErrorEnhancer
UndefinedFunctionErrorEnhancer
UndefinedMethodErrorEnhancer
ErrorHandler
A generic ErrorHandler for the PHP engine.
CliErrorRenderer
FileLinkFormatter
Formats debug file links.
HtmlErrorRenderer
SerializerErrorRenderer
Formats an exception using Serializer for rendering.
FlattenException
FlattenException wraps a PHP Error or Exception to be able to serialize it.
SilencedErrorContext
Data Object that represents a Silenced Error.
AsEventListener
Service tag to autoconfigure event listeners.
TraceableEventDispatcher
Collects some data about event listeners.
WrappedListener
AddEventAliasesPass
This pass allows bundles to extend the list of event aliases.
RegisterListenersPass
Compiler pass to register tagged services for an event dispatcher.
EventDispatcher
The EventDispatcherInterface is the central point of Symfony's event listener system.
GenericEvent
Event encapsulation class.
ImmutableEventDispatcher
A read-only proxy for an event dispatcher.
Event
Event is the base class for classes containing event data.
Comparator
DateComparator
DateCompare compiles date comparisons.
NumberComparator
NumberComparator compiles a simple comparison to an anonymous subroutine, which you can call with a value to be tested again.
AccessDeniedException
DirectoryNotFoundException
Finder
Finder allows to build rules to find files and directories.
Gitignore
Gitignore matches against text.
Glob
Glob matches globbing patterns against text.
CustomFilterIterator
CustomFilterIterator filters files by applying anonymous functions.
DateRangeFilterIterator
DateRangeFilterIterator filters out files that are not in the given date range (last modified dates).
DepthRangeFilterIterator
DepthRangeFilterIterator limits the directory depth.
ExcludeDirectoryFilterIterator
ExcludeDirectoryFilterIterator filters out directories.
FilecontentFilterIterator
FilecontentFilterIterator filters files by their contents using patterns (regexps or strings).
FilenameFilterIterator
FilenameFilterIterator filters files by patterns (a regexp, a glob, or a string).
FileTypeFilterIterator
FileTypeFilterIterator only keeps files, directories, or both.
MultiplePcreFilterIterator
MultiplePcreFilterIterator filters files using patterns (regexps, globs or strings).
PathFilterIterator
PathFilterIterator filters files by path patterns (e.g. some/special/dir).
RecursiveDirectoryIterator
Extends the \RecursiveDirectoryIterator to support relative paths.
SizeRangeFilterIterator
SizeRangeFilterIterator filters out files that are not in the given size range.
SortableIterator
SortableIterator applies a sort on a given Iterator.
VcsIgnoredFilterIterator
SplFileInfo
Extends \SplFileInfo to support relative paths.
AcceptHeader
Represents an Accept-* header.
AcceptHeaderItem
Represents an Accept-* header item.
BinaryFileResponse
BinaryFileResponse represents an HTTP response delivering a file.
ChainRequestMatcher
ChainRequestMatcher verifies that all checks match against a Request instance.
Cookie
Represents a cookie.
BadRequestException
Raised when a user sends a malformed request.
ConflictingHeadersException
The HTTP request contains headers with conflicting information.
JsonException
Thrown by Request::toArray() when the content cannot be JSON-decoded.
SessionNotFoundException
Raised when a session does not exist. This happens in the following cases: - the session is not enabled - attempt to read a session outside a request context (ie. cli script).
SuspiciousOperationException
Raised when a user has performed an operation that should be considered suspicious from a security perspective.
UnexpectedValueException
ExpressionRequestMatcher
ExpressionRequestMatcher uses an expression to match a Request.
AccessDeniedException
Thrown when the access on a file was denied.
CannotWriteFileException
Thrown when an UPLOAD_ERR_CANT_WRITE error occurred with UploadedFile.
ExtensionFileException
Thrown when an UPLOAD_ERR_EXTENSION error occurred with UploadedFile.
FileException
Thrown when an error occurred in the component File.
FileNotFoundException
Thrown when a file was not found.
FormSizeFileException
Thrown when an UPLOAD_ERR_FORM_SIZE error occurred with UploadedFile.
IniSizeFileException
Thrown when an UPLOAD_ERR_INI_SIZE error occurred with UploadedFile.
NoFileException
Thrown when an UPLOAD_ERR_NO_FILE error occurred with UploadedFile.
NoTmpDirFileException
Thrown when an UPLOAD_ERR_NO_TMP_DIR error occurred with UploadedFile.
PartialFileException
Thrown when an UPLOAD_ERR_PARTIAL error occurred with UploadedFile.
UnexpectedTypeException
Thrown when an error occurred in the component File.
UploadException
Thrown when an error occurred during file upload.
File
A file in the file system.
Stream
A PHP stream of unknown size.
UploadedFile
A file uploaded through a form.
FileBag
FileBag is a container for uploaded files.
HeaderBag
HeaderBag is a container for HTTP headers.
HeaderUtils
HTTP header utility functions.
InputBag
InputBag is a container for user input values such as $_GET, $_POST, $_REQUEST, and $_COOKIE.
IpUtils
Http utility functions.
JsonResponse
Response represents an HTTP response in JSON format.
ParameterBag
ParameterBag is a container for key/value pairs.
AbstractRequestRateLimiter
An implementation of PeekableRequestRateLimiterInterface that fits most use-cases.
RedirectResponse
RedirectResponse represents an HTTP response doing a redirect.
Request
Request represents an HTTP request.
AttributesRequestMatcher
Checks the Request attributes matches all regular expressions.
ExpressionRequestMatcher
ExpressionRequestMatcher uses an expression to match a Request.
HostRequestMatcher
Checks the Request URL host name matches a regular expression.
IpsRequestMatcher
Checks the client IP of a Request.
IsJsonRequestMatcher
Checks the Request content is valid JSON.
MethodRequestMatcher
Checks the HTTP method of a Request.
PathRequestMatcher
Checks the Request URL path info matches a regular expression.
PortRequestMatcher
Checks the HTTP port of a Request.
SchemeRequestMatcher
Checks the HTTP scheme of a Request.
RequestMatcher
RequestMatcher compares a pre-defined set of checks against a Request instance.
RequestStack
Request stack that controls the lifecycle of requests.
Response
Response represents an HTTP response.
ResponseHeaderBag
ResponseHeaderBag is a container for Response HTTP headers.
ServerBag
ServerBag is a container for HTTP headers from the $_SERVER variable.
AttributeBag
This class relates to session attribute storage.
AutoExpireFlashBag
AutoExpireFlashBag flash message container.
FlashBag
FlashBag flash message container.
Session
SessionFactory
AbstractSessionHandler
This abstract session handler provides a generic implementation of the PHP 7.0 SessionUpdateTimestampHandlerInterface, enabling strict and lazy session handling.
IdentityMarshaller
MarshallingSessionHandler
MemcachedSessionHandler
Memcached based session storage handler based on the Memcached class provided by the PHP memcached extension.
MigratingSessionHandler
Migrating session handler for migrating from one handler to another. It reads from the current handler and writes both the current and new ones.
MongoDbSessionHandler
Session handler using the MongoDB driver extension.
NativeFileSessionHandler
Native session handler using PHP's built in file storage.
NullSessionHandler
Can be used in unit testing or in a situations where persisted sessions are not desired.
PdoSessionHandler
Session handler using a PDO connection to read and write data.
RedisSessionHandler
Redis based session storage handler based on the Redis class provided by the PHP redis extension.
SessionHandlerFactory
StrictSessionHandler
Adds basic `SessionUpdateTimestampHandlerInterface` behaviors to another `SessionHandlerInterface`.
MetadataBag
Metadata container.
MockArraySessionStorage
MockArraySessionStorage mocks the session for unit tests.
MockFileSessionStorage
MockFileSessionStorage is used to mock sessions for functional testing where you may need to persist session data across separate PHP processes.
MockFileSessionStorageFactory
NativeSessionStorage
This provides a base class for session attribute storage.
NativeSessionStorageFactory
PhpBridgeSessionStorage
Allows session to be started by PHP and managed by Symfony.
PhpBridgeSessionStorageFactory
AbstractProxy
SessionHandlerProxy
StreamedJsonResponse
StreamedJsonResponse represents a streamed HTTP response for JSON.
StreamedResponse
StreamedResponse represents a streamed HTTP response.
RequestAttributeValueSame
ResponseCookieValueSame
ResponseFormatSame
Asserts that the response is in the given format.
ResponseHasCookie
ResponseHasHeader
ResponseHeaderLocationSame
ResponseHeaderSame
ResponseIsRedirected
ResponseIsSuccessful
ResponseIsUnprocessable
ResponseStatusCodeSame
UriSigner
UrlHelper
A helper service for manipulating URLs within and outside the request scope.
AsController
Autoconfigures controllers as services by applying the `controller.service_arguments` tag to them.
AsTargetedValueResolver
Service tag to autoconfigure targeted value resolvers.
Cache
Describes the default HTTP cache headers on controllers.
MapDateTime
Controller parameter tag to configure DateTime arguments.
MapQueryParameter
Can be used to pass a query parameter to a controller argument.
MapQueryString
Controller parameter tag to map the query string of the request to typed object and validate it.
MapRequestPayload
Controller parameter tag to map the request content to typed object and validate it.
ValueResolver
WithHttpStatus
WithLogLevel
AbstractBundle
A Bundle that provides configuration hooks.
Bundle
An implementation of BundleInterface that adds a few conventions for DependencyInjection extensions.
ChainCacheClearer
ChainCacheClearer.
Psr6CacheClearer
CacheWarmer
Abstract cache warmer that knows how to write a file to the cache.
CacheWarmerAggregate
Aggregates several cache warmers into a single one.
FileLocator
FileLocator uses the KernelInterface to locate resources in bundles.
BackedEnumValueResolver
Attempt to resolve backed enum cases from request attributes, for a route path parameter, leading to a 404 Not Found if the attribute value isn't a valid backing value for the enum type.
DateTimeValueResolver
Convert DateTime instances from request attribute variable.
DefaultValueResolver
Yields the default value defined in the action signature when no value has been given.
NotTaggedControllerValueResolver
Provides an intuitive error message when controller fails because it is not registered as a service.
QueryParameterValueResolver
Resolve arguments of type: array, string, int, float, bool, \BackedEnum from query parameters.
RequestAttributeValueResolver
Yields a non-variadic argument's value from the request attributes.
RequestPayloadValueResolver
RequestValueResolver
Yields the same instance as the request object passed along.
ServiceValueResolver
Yields a service keyed by _controller and argument name.
SessionValueResolver
Yields the Session.
TraceableValueResolver
Provides timing information via the stopwatch.
UidValueResolver
VariadicValueResolver
Yields a variadic argument's values from the request attributes.
ArgumentResolver
Responsible for resolving the arguments passed to an action.
ContainerControllerResolver
A controller resolver searching for a controller in a psr-11 container when using the "service::method" notation.
ControllerReference
Acts as a marker and a data holder for a Controller.
ControllerResolver
This implementation uses the '_controller' request attribute to determine the controller to execute.
ErrorController
Renders error or exception pages from a given FlattenException.
TraceableArgumentResolver
TraceableControllerResolver
ArgumentMetadata
Responsible for storing metadata of an argument.
ArgumentMetadataFactory
Builds {@see ArgumentMetadata} objects based on the given Controller.
AjaxDataCollector
DataCollector.
ConfigDataCollector
DataCollector.
DataCollector
DataCollector.
DumpDataCollector
DataCollector.
EventDataCollector
DataCollector.
ExceptionDataCollector
DataCollector.
LoggerDataCollector
DataCollector.
MemoryDataCollector
DataCollector.
RequestDataCollector
DataCollector.
RouterDataCollector
DataCollector.
TimeDataCollector
DataCollector.
FileLinkFormatter
Formats debug file links.
TraceableEventDispatcher
Collects some data about event listeners.
AddAnnotatedClassesToCachePass
Sets the classes to compile in the cache for the container.
ConfigurableExtension
This extension sub-class provides first-class integration with the Config/Definition Component.
ControllerArgumentValueResolverPass
Gathers and configures the argument value resolvers.
Extension
Allow adding classes to the class cache.
FragmentRendererPass
Adds services tagged kernel.fragment_renderer as HTTP content rendering strategies.
LazyLoadingFragmentHandler
Lazily loads fragment renderers from the dependency injection container.
LoggerPass
Registers the default logger if necessary.
MergeExtensionConfigurationPass
Ensures certain extensions are always loaded.
RegisterControllerArgumentLocatorsPass
Creates the service-locators required by ServiceValueResolver.
RegisterLocaleAwareServicesPass
Register all services that have the "kernel.locale_aware" tag into the listener.
RemoveEmptyControllerArgumentLocatorsPass
Removes empty service-locators registered for ServiceValueResolver.
ResettableServicePass
ControllerArgumentsEvent
Allows filtering of controller arguments.
ControllerEvent
Allows filtering of a controller callable.
ExceptionEvent
Allows to create a response for a thrown exception.
FinishRequestEvent
Triggered whenever a request is fully processed.
KernelEvent
Base class for events dispatched in the HttpKernel component.
RequestEvent
Allows to create a response for a request.
ResponseEvent
Allows to filter a Response object.
TerminateEvent
Allows to execute logic after a response was sent.
ViewEvent
Allows to create a response for the return value of a controller.
AbstractSessionListener
Sets the session onto the request on the "kernel.request" event and saves it on the "kernel.response" event.
AddRequestFormatsListener
Adds configured formats to each request.
CacheAttributeListener
Handles HTTP cache headers configured via the Cache attribute.
DisallowRobotsIndexingListener
Ensures that the application is not indexed by search engines.
DumpListener
Configures dump() handler.
ErrorListener
FragmentListener
Handles content fragments represented by special URIs.
LocaleAwareListener
Pass the current locale to the provided services.
LocaleListener
Initializes the locale based on the current request.
ProfilerListener
ProfilerListener collects data for the current request by listening to the kernel events.
ResponseListener
ResponseListener fixes the Response headers based on the Request.
RouterListener
Initializes the context from the request and sets request attributes based on a matching route.
SessionListener
Sets the session in the request.
StreamedResponseListener
StreamedResponseListener is responsible for sending the Response to the client.
SurrogateListener
SurrogateListener adds a Surrogate-Control HTTP header when the Response needs to be parsed for Surrogates.
ValidateRequestListener
Validates Requests.
AccessDeniedHttpException
HttpException.
BadRequestHttpException
HttpException.
ConflictHttpException
HttpException.
ControllerDoesNotReturnResponseException
GoneHttpException
HttpException.
HttpException
HttpException.
InvalidMetadataException
LengthRequiredHttpException
HttpException.
LockedHttpException
HttpException.
MethodNotAllowedHttpException
HttpException.
NotAcceptableHttpException
HttpException.
NotFoundHttpException
HttpException.
PreconditionFailedHttpException
HttpException.
PreconditionRequiredHttpException
HttpException.
ResolverNotFoundException
ServiceUnavailableHttpException
HttpException.
TooManyRequestsHttpException
HttpException.
UnauthorizedHttpException
HttpException.
UnexpectedSessionUsageException
UnprocessableEntityHttpException
HttpException.
UnsupportedMediaTypeHttpException
HttpException.
AbstractSurrogateFragmentRenderer
Implements Surrogate rendering strategy.
EsiFragmentRenderer
Implements the ESI rendering strategy.
FragmentHandler
Renders a URI that represents a resource fragment.
FragmentUriGenerator
Generates a fragment URI.
HIncludeFragmentRenderer
Implements the Hinclude rendering strategy.
InlineFragmentRenderer
Implements the inline rendering strategy where the Request is rendered by the current HTTP kernel.
RoutableFragmentRenderer
Adds the possibility to generate a fragment URI for a given Controller.
SsiFragmentRenderer
Implements the SSI rendering strategy.
AbstractSurrogate
Abstract class implementing Surrogate capabilities to Request and Response instances.
Esi
Esi implements the ESI capabilities to Request and Response instances.
HttpCache
Cache provides HTTP caching.
ResponseCacheStrategy
ResponseCacheStrategy knows how to compute the Response cache HTTP header based on the different response cache headers.
Ssi
Ssi implements the SSI capabilities to Request and Response instances.
Store
Store implements all the logic for storing cache metadata (Request and Response headers).
HttpClientKernel
An implementation of a Symfony HTTP kernel using a "real" HTTP client.
HttpKernel
HttpKernel notifies events to convert a Request object to a Response one.
HttpKernelBrowser
Simulates a browser and makes requests to an HttpKernel instance.
Kernel
The Kernel is the heart of the Symfony system.
KernelEvents
Contains all events thrown in the HttpKernel component.
DebugLoggerConfigurator
Logger
Minimalist PSR-3 logger designed to write in stderr or any other stream.
FileProfilerStorage
Storage for profiler using files.
Profile
Profile.
Profiler
Profiler.
UriSigner
MailerTestCommand
A console command to test Mailer transports.
MessageDataCollector
DataCollector.
Envelope
FailedMessageEvent
Event is the base class for classes containing event data.
MessageEvent
Allows the transformation of a Message and the Envelope before the email is sent.
MessageEvents
SentMessageEvent
Event is the base class for classes containing event data.
EnvelopeListener
Manipulates the Envelope of a Message.
MessageListener
Manipulates the headers and the body of a Message.
MessageLoggerListener
Logs Messages.
MessengerTransportListener
Allows messages to be sent to specific Messenger transports via the "X-Bus-Transport" MIME header.
HttpTransportException
IncompleteDsnException
InvalidArgumentException
LogicException
RuntimeException
TransportException
UnexpectedResponseException
UnsupportedSchemeException
MetadataHeader
A Simple MIME Header.
TagHeader
A Simple MIME Header.
Mailer
MessageHandler
SendEmailMessage
SentMessage
EmailCount
EmailIsQueued
TransportFactoryTestCase
A test case to ease testing Transport Factory.
AbstractApiTransport
AbstractHttpTransport
AbstractTransport
AbstractTransportFactory
Dsn
FailoverTransport
Uses several Transports using a failover algorithm.
NativeTransportFactory
Factory that configures a transport (sendmail or SMTP) based on php.ini settings.
NullTransport
Pretends messages have been sent, but just ignores them.
NullTransportFactory
RoundRobinTransport
Uses several Transports using a round robin algorithm.
SendmailTransport
SendmailTransport for sending mail through a Sendmail/Postfix (etc..) binary.
SendmailTransportFactory
CramMd5Authenticator
Handles CRAM-MD5 authentication.
LoginAuthenticator
Handles LOGIN authentication.
PlainAuthenticator
Handles PLAIN authentication.
XOAuth2Authenticator
Handles XOAUTH2 authentication.
EsmtpTransport
Sends Emails over SMTP with ESMTP support.
EsmtpTransportFactory
SmtpTransport
Sends emails over SMTP.
Transports
Transport
Address
DkimOptions
A helper providing autocompletion for available DkimSigner options.
DkimSigner
SMimeEncrypter
SMimeSigner
AddMimeTypeGuesserPass
Registers custom mime types guessers.
DraftEmail
Email
Base64ContentEncoder
Base64Encoder
Base64MimeHeaderEncoder
EightBitContentEncoder
IdnAddressEncoder
An IDN email address encoder.
QpContentEncoder
QpEncoder
QpMimeHeaderEncoder
Rfc2231Encoder
AddressEncoderException
InvalidArgumentException
LogicException
RfcComplianceException
RuntimeException
FileBinaryMimeTypeGuesser
Guesses the MIME type with the binary "file" (only available on *nix).
FileinfoMimeTypeGuesser
Guesses the MIME type using the PECL extension FileInfo.
AbstractHeader
An abstract base MIME Header.
DateHeader
A Date MIME Header.
Headers
A collection of headers.
IdentificationHeader
An ID MIME Header for something like Message-ID or Content-ID (one or more addresses).
MailboxHeader
A Mailbox MIME Header for something like Sender (one named address).
MailboxListHeader
A Mailbox list MIME Header for something like From, To, Cc, and Bcc (one or more named addresses).
ParameterizedHeader
A Simple MIME Header.
PathHeader
A Path Header, such a Return-Path (one address).
UnstructuredHeader
A Simple MIME Header.
DefaultHtmlToTextConverter
LeagueHtmlToMarkdownConverter
Message
MessageConverter
MimeTypes
Manages MIME types and file extensions.
AbstractMultipartPart
AbstractPart
DataPart
File
MessagePart
AlternativePart
DigestPart
FormDataPart
Implements RFC 7578.
MixedPart
RelatedPart
SMimePart
TextPart
RawMessage
EmailAddressContains
EmailAttachmentCount
EmailHasHeader
EmailHeaderSame
EmailHtmlBodyContains
EmailSubjectContains
EmailTextBodyContains
Normalizer
Attribute
PhpToken
UnhandledMatchError
ValueError
DateError
DateException
DateInvalidOperationException
DateInvalidTimeZoneException
DateMalformedIntervalStringException
DateMalformedPeriodStringException
DateMalformedStringException
DateObjectError
DateRangeError
Override
SQLite3Exception
InvalidArgumentException
InvalidArgumentException for the Process Component.
LogicException
LogicException for the Process Component.
ProcessFailedException
Exception for failed processes.
ProcessSignaledException
Exception that is thrown when a process has been signaled.
ProcessTimedOutException
Exception that is thrown when a process times out.
RunProcessFailedException
RuntimeException for the Process Component.
RuntimeException
RuntimeException for the Process Component.
ExecutableFinder
Generic executable finder.
InputStream
Provides a way to continuously write to the input of a Process until the InputStream is closed.
RunProcessContext
RunProcessMessage
RunProcessMessageHandler
PhpExecutableFinder
An executable finder specifically designed for the PHP executable.
PhpProcess
PhpProcess runs a PHP script in an independent process.
PhpSubprocess
PhpSubprocess runs a PHP command as a subprocess while keeping the original php.ini settings.
Process
Process is a thin wrapper around proc_* functions to easily start independent PHP processes.
ProcessUtils
ProcessUtils is a bunch of utility methods.
Alias
Route
Annotation class for @Route().
Route
Annotation class for @Route().
CompiledRoute
CompiledRoutes are returned by the RouteCompiler class.
AddExpressionLanguageProvidersPass
Registers the expression language providers.
RoutingResolverPass
Adds tagged routing.loader services to routing.resolver service.
InvalidArgumentException
InvalidParameterException
Exception thrown when a parameter is not valid.
MethodNotAllowedException
The resource was found but the request method is not allowed.
MissingMandatoryParametersException
Exception thrown when a route cannot be generated because of missing mandatory parameters.
NoConfigurationException
Exception thrown when no routes are configured.
ResourceNotFoundException
The resource was not found.
RouteCircularReferenceException
RouteNotFoundException
Exception thrown when a route does not exist.
RuntimeException
CompiledUrlGenerator
Generates URLs based on rules dumped by CompiledUrlGeneratorDumper.
CompiledUrlGeneratorDumper
CompiledUrlGeneratorDumper creates a PHP array to be used with CompiledUrlGenerator.
GeneratorDumper
GeneratorDumper is the base class for all built-in generator dumpers.
UrlGenerator
UrlGenerator can generate a URL or a path for any route in the RouteCollection based on the passed parameters.
AnnotationClassLoader
AttributeClassLoader loads routing information from a PHP class and its methods.
AnnotationDirectoryLoader
AttributeDirectoryLoader loads routing information from attributes set on PHP classes and methods.
AnnotationFileLoader
AttributeFileLoader loads routing information from attributes set on a PHP class and its methods.
AttributeClassLoader
AttributeClassLoader loads routing information from a PHP class and its methods.
AttributeDirectoryLoader
AttributeDirectoryLoader loads routing information from attributes set on PHP classes and methods.
AttributeFileLoader
AttributeFileLoader loads routing information from attributes set on a PHP class and its methods.
ClosureLoader
ClosureLoader loads routes from a PHP closure.
AliasConfigurator
CollectionConfigurator
ImportConfigurator
RouteConfigurator
RoutingConfigurator
ContainerLoader
A route loader that executes a service from a PSR-11 container to load the routes.
DirectoryLoader
GlobFileLoader
GlobFileLoader loads files from a glob pattern.
ObjectLoader
A route loader that calls a method on an object to load the routes.
PhpFileLoader
PhpFileLoader loads routes from a PHP file.
Psr4DirectoryLoader
A loader that discovers controller classes in a directory that follows PSR-4.
XmlFileLoader
XmlFileLoader loads XML routing files.
YamlFileLoader
YamlFileLoader loads Yaml routing files.
CompiledUrlMatcher
Matches URLs based on rules dumped by CompiledUrlMatcherDumper.
CompiledUrlMatcherDumper
CompiledUrlMatcherDumper creates PHP arrays to be used with CompiledUrlMatcher.
MatcherDumper
MatcherDumper is the abstract class for all built-in matcher dumpers.
ExpressionLanguageProvider
Exposes functions defined in the request context to route conditions.
RedirectableUrlMatcher
UrlMatcher matches URL based on a set of routes.
TraceableUrlMatcher
TraceableUrlMatcher helps debug path info matching by tracing the match.
UrlMatcher
UrlMatcher matches URL based on a set of routes.
RequestContext
Holds information about the current request.
EnumRequirement
Route
A Route describes a route and its parameters.
RouteCollection
A RouteCollection represents a set of Route instances.
RouteCompiler
RouteCompiler compiles Route instances to CompiledRoute instances.
Router
The Router class is an example of the integration of all pieces of the routing system for easier use.
Required
A required dependency.
SubscribedService
For use as the return value for {@see ServiceSubscriberInterface}.
ServiceLocatorTest
ServiceLocatorTestCase
AbstractString
Represents a string of abstract characters.
AbstractUnicodeString
Represents a string of abstract Unicode characters.
ByteString
Represents a binary-safe string of bytes.
CodePointString
Represents a string of Unicode code points encoded as UTF-8.
InvalidArgumentException
RuntimeException
EnglishInflector
FrenchInflector
French inflector.
SpanishInflector
LazyString
A string whose value is computed lazily by a callback.
AsciiSlugger
UnicodeString
Represents a string of Unicode grapheme clusters encoded as UTF-8.
AbstractOperation
Base catalogues binary operation class.
MergeOperation
Merge operation between two catalogues as follows: all = source ∪ target = {x: x ∈ source ∨ x ∈ target} new = all ∖ source = {x: x ∈ target ∧ x ∉ source} obsolete = source ∖ all = {x: x ∈ source ∧ x ∉ source ∧ x ∉ target} = ∅ Basically, the result contains messages from both catalogues.
TargetOperation
Target operation between two catalogues: intersection = source ∩ target = {x: x ∈ source ∧ x ∈ target} all = intersection ∪ (target ∖ intersection) = target new = all ∖ source = {x: x ∈ target ∧ x ∉ source} obsolete = source ∖ all = source ∖ target = {x: x ∈ source ∧ x ∉ target} Basically, the result contains messages from the target catalogue.
TranslationPullCommand
Base class for all commands.
TranslationPushCommand
Base class for all commands.
XliffLintCommand
Validates XLIFF files syntax and outputs encountered errors.
TranslationDataCollector
DataCollector.
DataCollectorTranslator
DataCollectorTranslatorPass
LoggingTranslatorPass
TranslationDumperPass
Adds tagged translation.formatter services to translation writer.
TranslationExtractorPass
Adds tagged translation.extractor services to translation extractor.
TranslatorPass
TranslatorPathsPass
CsvFileDumper
CsvFileDumper generates a csv formatted string representation of a message catalogue.
FileDumper
FileDumper is an implementation of DumperInterface that dump a message catalogue to file(s).
IcuResFileDumper
IcuResDumper generates an ICU ResourceBundle formatted string representation of a message catalogue.
IniFileDumper
IniFileDumper generates an ini formatted string representation of a message catalogue.
JsonFileDumper
JsonFileDumper generates an json formatted string representation of a message catalogue.
MoFileDumper
MoFileDumper generates a gettext formatted string representation of a message catalogue.
PhpFileDumper
PhpFileDumper generates PHP files from a message catalogue.
PoFileDumper
PoFileDumper generates a gettext formatted string representation of a message catalogue.
QtFileDumper
QtFileDumper generates ts files from a message catalogue.
XliffFileDumper
XliffFileDumper generates xliff files from a message catalogue.
YamlFileDumper
YamlFileDumper generates yaml files from a message catalogue.
IncompleteDsnException
Base InvalidArgumentException for the Translation component.
InvalidArgumentException
Base InvalidArgumentException for the Translation component.
InvalidResourceException
Thrown when a resource cannot be loaded.
LogicException
Base LogicException for Translation component.
MissingRequiredOptionException
Base InvalidArgumentException for the Translation component.
NotFoundResourceException
Thrown when a resource does not exist.
ProviderException
Base RuntimeException for the Translation component.
RuntimeException
Base RuntimeException for the Translation component.
UnsupportedSchemeException
Base LogicException for Translation component.
AbstractFileExtractor
Base class used by classes that extract translation messages from files.
ChainExtractor
ChainExtractor extracts translation messages from template files.
PhpAstExtractor
PhpAstExtractor extracts translation messages from a PHP AST.
PhpExtractor
PhpExtractor extracts translation messages from a PHP template.
PhpStringTokenParser
AbstractVisitor
ConstraintVisitor
TranslatableMessageVisitor
TransMethodVisitor
IntlFormatter
MessageFormatter
IdentityTranslator
IdentityTranslator does not translate anything.
ArrayLoader
ArrayLoader loads translations from a PHP array.
CsvFileLoader
CsvFileLoader loads translations from CSV files.
FileLoader
ArrayLoader loads translations from a PHP array.
IcuDatFileLoader
IcuResFileLoader loads translations from a resource bundle.
IcuResFileLoader
IcuResFileLoader loads translations from a resource bundle.
IniFileLoader
IniFileLoader loads translations from an ini file.
JsonFileLoader
JsonFileLoader loads translations from an json file.
MoFileLoader
ArrayLoader loads translations from a PHP array.
PhpFileLoader
PhpFileLoader loads translations from PHP files returning an array of translations.
PoFileLoader
ArrayLoader loads translations from a PHP array.
QtFileLoader
QtFileLoader loads translations from QT Translations XML files.
XliffFileLoader
XliffFileLoader loads translations from XLIFF files.
YamlFileLoader
YamlFileLoader loads translations from Yaml files.
LocaleSwitcher
LoggingTranslator
MessageCatalogue
AbstractProviderFactory
Dsn
FilteringProvider
Filters domains and locales between the Translator config values and those specific to each provider.
NullProvider
NullProviderFactory
TranslationProviderCollection
TranslationProviderCollectionFactory
PseudoLocalizationTranslator
This translator should only be used in a development environment.
TranslationReader
TranslationReader reads translation messages from translation files.
ProviderFactoryTestCase
A test case to ease testing a translation provider factory.
ProviderTestCase
A test case to ease testing a translation provider.
TranslatableMessage
Translator
TranslatorBag
ArrayConverter
ArrayConverter generates tree like structure from a message catalogue.
XliffUtils
Provides some utility methods for XLIFF translation files, such as validating their contents according to the XSD schema.
TranslationWriter
TranslationWriter writes translation messages.
TranslatorTest
Test should cover all languages mentioned on http://translate.sourceforge.net/wiki/l10n/pluralforms and Plural forms mentioned on http://www.gnu.org/software/gettext/manual/gettext.html#Plural-forms.
AbstractUid
GenerateUlidCommand
Base class for all commands.
GenerateUuidCommand
Base class for all commands.
InspectUlidCommand
Base class for all commands.
InspectUuidCommand
Base class for all commands.
NameBasedUuidFactory
RandomBasedUuidFactory
TimeBasedUuidFactory
UlidFactory
UuidFactory
MaxUlid
A ULID is lexicographically sortable and contains a 48-bit timestamp and 80-bit of crypto-random entropy.
MaxUuid
NilUlid
A ULID is lexicographically sortable and contains a 48-bit timestamp and 80-bit of crypto-random entropy.
NilUuid
Ulid
A ULID is lexicographically sortable and contains a 48-bit timestamp and 80-bit of crypto-random entropy.
Uuid
UuidV1
A v1 UUID contains a 60-bit timestamp and 62 extra unique bits.
UuidV3
A v3 UUID contains an MD5 hash of another UUID and a name.
UuidV4
A v4 UUID contains a 122-bit random number.
UuidV5
A v5 UUID contains a SHA1 hash of another UUID and a name.
UuidV6
A v6 UUID is lexicographically sortable and contains a 60-bit timestamp and 62 extra unique bits.
UuidV7
A v7 UUID is lexicographically sortable and contains a 48-bit timestamp and 74 extra unique bits.
UuidV8
A v8 UUID has no explicit requirements except embedding its version + variant bits.
AmqpCaster
Casts Amqp related classes to array representation.
ArgsStub
Represents a list of function arguments.
Caster
Helper for filtering out properties in casters.
ClassStub
Represents a PHP class identifier.
ConstStub
Represents a PHP constant and its value.
CutArrayStub
Represents a cut array.
CutStub
Represents the main properties of a PHP variable, pre-casted by a caster.
DateCaster
Casts DateTimeInterface related classes to array representation.
DoctrineCaster
Casts Doctrine related classes to array representation.
DOMCaster
Casts DOM related classes to array representation.
DsCaster
Casts Ds extension classes to array representation.
DsPairStub
Represents the main properties of a PHP variable.
EnumStub
Represents an enumeration of values.
ExceptionCaster
Casts common Exception classes to array representation.
FFICaster
Casts FFI extension classes to array representation.
FiberCaster
Casts Fiber related classes to array representation.
FrameStub
Represents a single backtrace frame as returned by debug_backtrace() or Exception->getTrace().
GmpCaster
Casts GMP objects to array representation.
ImagineCaster
ImgStub
Represents a PHP constant and its value.
IntlCaster
LinkStub
Represents a file or a URL.
MemcachedCaster
PdoCaster
Casts PDO related classes to array representation.
PgSqlCaster
Casts pqsql resources to array representation.
ProxyManagerCaster
RdKafkaCaster
Casts RdKafka related classes to array representation.
RedisCaster
Casts Redis class from ext-redis to array representation.
ReflectionCaster
Casts Reflector related classes to array representation.
ResourceCaster
Casts common resource types to array representation.
ScalarStub
Represents any arbitrary value.
SplCaster
Casts SPL related classes to array representation.
StubCaster
Casts a caster's Stub.
SymfonyCaster
TraceStub
Represents a backtrace as returned by debug_backtrace() or Exception->getTrace().
UninitializedStub
Represents an uninitialized property.
UuidCaster
XmlReaderCaster
Casts XmlReader class to array representation.
XmlResourceCaster
Casts XML resources to array representation.
AbstractCloner
AbstractCloner implements a generic caster mechanism for objects and resources.
Cursor
Represents the current state of a dumper while dumping.
Data
Stub
Represents the main properties of a PHP variable.
VarCloner
AbstractCloner implements a generic caster mechanism for objects and resources.
CliDescriptor
Describe collected data clones for cli output.
HtmlDescriptor
Describe collected data clones for html output.
ServerDumpCommand
Starts a dump server to collect and output dumps on a single place with multiple formats support.
AbstractDumper
Abstract mechanism for dumping a Data object.
CliDumper
CliDumper dumps variables for command line output.
CliContextProvider
Tries to provide context on CLI.
RequestContextProvider
Tries to provide context from a request.
SourceContextProvider
Tries to provide context from sources (class name, file, line, code excerpt, ...).
ContextualizedDumper
HtmlDumper
HtmlDumper dumps variables as HTML.
ServerDumper
ServerDumper forwards serialized Data clones to a server.
ThrowingCasterException
Connection
Forwards serialized Data clones to a server.
DumpServer
A server collecting Data clones sent by a ServerDumper.
VarDumper
ClassNotFoundException
LogicException
NotInstantiableTypeException
Hydrator
Utility class to hydrate the properties of an object.
Instantiator
A utility class to create objects without calling their constructor.
ProxyHelper
VarExporter
Exports serializable PHP values to PHP code.
LintCommand
Validates YAML files syntax and outputs encountered errors.
Dumper
Dumper dumps PHP variables to YAML strings.
DumpException
Exception class thrown when an error occurs during dumping.
ParseException
Exception class thrown when an error occurs during parsing.
RuntimeException
Exception class thrown when an error occurs during parsing.
Parser
Parser parses YAML strings to convert them to PHP arrays.
TaggedValue
Yaml
Yaml offers convenience methods to load and dump YAML.
Exception
NamespaceUri
NamespaceUriException
Token
TokenCollection
TokenCollectionException
Tokenizer
XMLSerializer
Processor
Processor
Property
Processor
Rule
CssToInlineStyles
Dotenv
InvalidEncodingException
InvalidFileException
InvalidPathException
ValidationException
Loader
Resolver
Entry
EntryParser
Lexer
Lines
Parser
Value
ApacheAdapter
ArrayAdapter
EnvConstAdapter
GuardedWriter
ImmutableWriter
MultiReader
MultiWriter
PutenvAdapter
ReplacingWriter
ServerConstAdapter
AdapterRepository
RepositoryBuilder
FileStore
StoreBuilder
StringStore
Validator
ASCII
## 🇷🇺 Русским гражданам В Украине сейчас идет война. Силами РФ наносятся удары по гражданской инфраструктуре в [Харькове][1], [Киеве][2], [Чернигове][3], [Сумах][4], [Ирпене][5] и десятках других городов. Гибнут люди - и гражданское население, и военные, в том числе российские призывники, которых бросили воевать. Чтобы лишить собственный народ доступа к информации, правительство РФ запретило называть войну войной, закрыло независимые СМИ и принимает сейчас ряд диктаторских законов. Эти законы призваны заткнуть рот всем, кто против войны. За обычный призыв к миру сейчас можно получить несколько лет тюрьмы.
Assert
Efficient assertions to validate the input/output of your methods.
InvalidArgumentException
AttributeAnnotationFactory
ComposerAutoloaderScanner
Scans for classes/interfaces/traits.
DocBlockAnnotationFactory
DocBlockParser
Extract swagger-php annotations from a [PHPDoc](http://en.wikipedia.org/wiki/PHPDoc) using Doctrine's DocParser.
ReflectionAnalyser
OpenApi analyser using reflection.
TokenAnalyser
Extracts swagger-php annotations from php code using static analysis.
TokenScanner
High level, PHP token based, scanner.
Analysis
Result of the analyser.
AbstractAnnotation
The openapi annotation base class.
AdditionalProperties
The definition of input and output data types.
Attachable
A container for custom data to be attached to an annotation.
Components
Holds a set of reusable objects for different aspects of the OA.
Contact
Contact information for the exposed API.
CookieParameter
A `@OA\Request` cookie parameter.
Delete
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Discriminator
The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.
Examples
The openapi annotation base class.
ExternalDocumentation
Allows referencing an external resource for extended documentation.
Flow
Configuration details for a supported OAuth Flow.
Get
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Head
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Header
The openapi annotation base class.
HeaderParameter
A `@OA\Request` header parameter.
Info
The object provides metadata about the API.
Items
The description of an item in a Schema with type `array`.
JsonContent
Shorthand for a json response.
License
License information for the exposed API.
Link
The Link object represents a possible design-time link for a response.
MediaType
Each Media Type object provides schema and examples for the media type identified by its key.
OpenApi
This is the root document object for the API specification.
Operation
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Options
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Parameter
Describes a single operation parameter.
Patch
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
PathItem
Describes the operations available on a single path.
PathParameter
A `@OA\Request` path parameter.
Post
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Property
The definition of input and output data types.
Put
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
QueryParameter
A `@OA\Request` query parameter.
RequestBody
Describes a single request body.
Response
Describes a single response from an API Operation, including design-time, static links to operations based on the response.
Schema
The definition of input and output data types.
SecurityScheme
The openapi annotation base class.
Server
An object representing a server.
ServerVariable
An object representing a server variable for server URL template substitution.
Tag
The openapi annotation base class.
Trace
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Webhook
Acts like a `PathItem` with the main difference being that it requires `webhook` instead of `path`.
Xml
The openapi annotation base class.
XmlContent
Shorthand for a xml response.
AdditionalProperties
The definition of input and output data types.
Attachable
A container for custom data to be attached to an annotation.
Components
Holds a set of reusable objects for different aspects of the OA.
Contact
Contact information for the exposed API.
CookieParameter
Describes a single operation parameter.
Delete
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Discriminator
The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.
Examples
The openapi annotation base class.
ExternalDocumentation
Allows referencing an external resource for extended documentation.
Flow
Configuration details for a supported OAuth Flow.
Get
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Head
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Header
The openapi annotation base class.
HeaderParameter
Describes a single operation parameter.
Info
The object provides metadata about the API.
Items
The description of an item in a Schema with type `array`.
JsonContent
Shorthand for a json response.
License
License information for the exposed API.
Link
The Link object represents a possible design-time link for a response.
MediaType
Each Media Type object provides schema and examples for the media type identified by its key.
OpenApi
This is the root document object for the API specification.
Options
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Parameter
Describes a single operation parameter.
Patch
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
PathItem
Describes the operations available on a single path.
PathParameter
Describes a single operation parameter.
Post
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Property
The definition of input and output data types.
Put
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
QueryParameter
Describes a single operation parameter.
RequestBody
Describes a single request body.
Response
Describes a single response from an API Operation, including design-time, static links to operations based on the response.
Schema
The definition of input and output data types.
SecurityScheme
The openapi annotation base class.
Server
An object representing a server.
ServerVariable
An object representing a server variable for server URL template substitution.
Tag
The openapi annotation base class.
Trace
Base class for `@OA\Get`, `@OA\Post`, `@OA\Put`, etc.
Webhook
Acts like a `PathItem` with the main difference being that it requires `webhook` instead of `path`.
Xml
The openapi annotation base class.
XmlContent
Shorthand for a xml response.
Context
The context in which the annotation is parsed.
Generator
OpenApi spec generator.
ConsoleLogger
This is a simple Logger implementation that other Loggers can inherit from.
DefaultLogger
This is a simple Logger implementation that other Loggers can inherit from.
OpenApiException
Pipeline
AugmentParameters
Augments shared and operations parameters from docblock comments.
AugmentProperties
Use the property context to extract useful information and inject that into the annotation.
AugmentRefs
AugmentRequestBody
Use the RequestBody context to extract useful information and inject that into the annotation.
AugmentSchemas
Use the Schema context to extract useful information and inject that into the annotation.
AugmentTags
Ensures that all tags used on operations also exist in the global <code>tags</code> list.
BuildPaths
Build the openapi->paths using the detected `@OA\PathItem` and `@OA\Operation` (`@OA\Get`, `@OA\Post`, etc).
CleanUnmerged
CleanUnusedComponents
Tracks the use of all <code>Components</code> and removed unused schemas.
DocBlockDescriptions
Checks if the annotation has a summary and/or description property and uses the text in the comment block (above the annotations) as summary and/or description.
ExpandClasses
Iterate over the chain of ancestors of a schema and: - if the ancestor has a schema => inherit from the ancestor if it has a schema (allOf) and stop.
ExpandEnums
Expands PHP enums.
ExpandInterfaces
Look at all (direct) interfaces for a schema and: - merge interfaces annotations/methods into the schema if the interface does not have a schema itself - inherit from the interface if it has a schema (allOf).
ExpandTraits
Look at all (direct) traits for a schema and: - merge trait annotations/methods/properties into the schema if the trait does not have a schema itself - inherit from the trait if it has a schema (allOf).
MergeIntoComponents
Merge reusable annotation into @OA\Schemas.
MergeIntoOpenApi
Merge all @OA\OpenApi annotations into one.
MergeJsonContent
Split JsonContent into Schema and MediaType.
MergeXmlContent
Split XmlContent into Schema and MediaType.
OperationId
Generate the OperationId based on the context of the OpenApi annotation.
PathFilter
Allows to filter endpoints based on tags and/or path.
Serializer
Allows to serialize/de-serialize annotations from/to JSON.
Util
Convenient utility functions that don't neatly fit anywhere else.

Traits

HandlesApiErrors
Trait HandlesApiErrors
HandlesWebErrors
CreatesApplication
CarbonTypeConverter
GeneratorAwareExtensionTrait
A helper trait to be used with GeneratorAwareExtension.
CacheTrait
IamSignerTrait
ServiceAccountSignerTrait
Sign a string using a Service Account private key.
ArrayTrait
Provides basic array helper methods.
BatchDaemonTrait
A utility trait related to BatchDaemon functionality.
BatchTrait
A trait to assist in the registering and processing of batch jobs.
HandleFailureTrait
A utility trait for handling failed items.
InterruptTrait
A trait to assist in handling interrupt signals and gracefully stopping work.
JobTrait
A trait to assist in implementing the JobInterface
SerializableClientTrait
A trait to assist in serializing/deserializing client configuration that may contain closures.
SimpleJobTrait
A trait to assist in the registering and processing of simple jobs.
CallTrait
Provide magic method support for fetching values from results
ClientTrait
Provides functionality common to each service client.
ConcurrencyControlTrait
Methods to control concurrent updates.
DebugInfoTrait
Provides easier to read debug information when dumping a class to stdout.
EmulatorTrait
Provides common logic for configuring the usage of an emulator.
GrpcTrait
Provides shared functionality for gRPC service implementations.
ItemIteratorTrait
This trait fulfills the [\Iterator](http://php.net/manual/en/class.iterator.php) interface and returns results from a paged set one at a time.
PageIteratorTrait
This trait fulfills the [\Iterator](http://php.net/manual/en/class.iterator.php) interface and returns results as a page of items.
JsonTrait
Provides wrappers for json_encode/json_decode that throw exceptions when an error is encountered.
LockTrait
Utility trait for locks.
FormatterTrait
Shared trait to enrich and format a record with App Engine Flex specific information.
LROTrait
Provide Long Running Operation support to Google Cloud PHP Clients.
OperationResponseTrait
Serializes and deserializes ApiCore LRO Response objects.
RequestWrapperTrait
Encapsulates shared functionality of request wrappers.
RestTrait
Provides shared functionality for REST service implementations.
RetryDeciderTrait
Provides methods for deciding if a request should be retried.
SysvTrait
A utility trait related to System V IPC.
TimeTrait
Helper methods for formatting and converting Timestamps.
UriTrait
Provides a light wrapper around often used URI related functions.
ValidateTrait
Methods for validating and verifying data
ValueMapperTrait
Provides common value mapping methods.
WhitelistTrait
Manages exceptions for requests which may have whitelist restrictions.
EncryptionTrait
Trait which provides helper methods for customer-supplied encryption.
OptionsTrait
Trait implemented by any class representing an associative array of PHP options.
ServiceAddressTrait
Provides helper methods for service address handling.
GetPublicDescriptorTrait
HasPublicDescriptorTrait
ClientTrait
Client interface for sending HTTP requests.
MessageTrait
Trait implementing functionality common to requests and responses.
StreamDecoratorTrait
Stream decorator trait
EditUserTrait
ExpirableTrait
KeysTrait
InstallsApiStack
InstallsBladeStack
InstallsInertiaStacks
InstallsLivewireStack
HandlesAuthorization
Authenticatable
CreatesUserProviders
GuardHelpers
These methods are typically the same across all guards.
MustVerifyEmail
CanResetPassword
UsePusherChannelConventions
InteractsWithBroadcasting
InteractsWithSockets
Batchable
Queueable
HasCacheLock
RetrievesMultipleKeys
EnumeratesValues
Conditionable
CallsCommands
ConfiguresPrompts
CreatesMatchingTest
HasParameters
InteractsWithIO
InteractsWithSignals
PromptsForMissingInput
ConfirmableTrait
ManagesFrequencies
BuildsQueries
CompilesJsonPaths
ExplainsQueries
ManagesTransactions
ParsesSearchPath
WithoutModelEvents
DetectsConcurrencyErrors
DetectsLostConnections
BroadcastsEvents
BroadcastsEventsAfterCommit
GuardsAttributes
HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HasUlids
HasUniqueIds
HasUuids
HidesAttributes
QueriesRelationships
HasFactory
MassPrunable
Prunable
AsPivot
CanBeOneOfMany
ComparesRelatedModels
InteractsWithDictionary
InteractsWithPivotTable
SupportsDefaultModels
SoftDeletes
ConnectsToDatabase
Authorizable
AuthorizesRequests
Dispatchable
DispatchesJobs
ResolvesDumpSource
Dispatchable
InteractsWithAuthentication
InteractsWithConsole
InteractsWithContainer
InteractsWithDatabase
InteractsWithDeprecationHandling
InteractsWithExceptionHandling
InteractsWithRedis
InteractsWithSession
InteractsWithTestCaseLifecycle
InteractsWithTime
InteractsWithViews
MakesHttpRequests
DatabaseMigrations
DatabaseTransactions
DatabaseTruncation
LazilyRefreshDatabase
RefreshDatabase
CanConfigureMigrationCommands
WithConsoleEvents
WithFaker
WithoutEvents
WithoutMiddleware
ValidatesRequests
DeterminesStatusCode
CanBePrecognitive
InteractsWithContentTypes
InteractsWithFlashData
InteractsWithInput
FileHelpers
CollectsResources
ConditionallyLoadsAttributes
DelegatesToResource
ResponseTrait
ParsesLogConfiguration
Macroable
HasDatabaseNotifications
Notifiable
RoutesNotifications
InteractsWithQueue
SerializesAndRestoresModelIdentifiers
SerializesModels
PacksPhpRedisValues
CreatesRegularExpressionRouteConstraints
FiltersControllerMiddleware
ResolvesRouteDependencies
RouteDependencyResolverTrait
InteractsWithTime
CapsuleManagerTrait
ForwardsCalls
Localizable
ReflectsClosures
Tappable
AssertsStatusCodes
RunsInParallel
TestDatabases
Debugging
Has
Interaction
Matching
CreatesPotentiallyTranslatedStrings
FormatsMessages
ReplacesAttributes
ValidatesAttributes
DatabaseRule
ValidatesWhenResolvedTrait
Provides default implementation of ValidatesWhenResolved contract.
CompilesAuthorizations
CompilesClasses
CompilesComments
CompilesComponents
CompilesConditionals
CompilesEchos
CompilesErrors
CompilesFragments
CompilesHelpers
CompilesIncludes
CompilesInjections
CompilesJs
CompilesJson
CompilesLayouts
CompilesLoops
CompilesRawPhp
CompilesSessions
CompilesStacks
CompilesStyles
CompilesTranslations
CompilesUseStatements
ManagesComponents
ManagesEvents
ManagesFragments
ManagesLayouts
ManagesLoops
ManagesStacks
ManagesTranslations
Colors
Cursor
Erase
Events
FakesInputOutput
Fallback
Interactivity
Scrolling
Termwind
Themes
Truncation
TypedValue
DrawsBoxes
DrawsScrollbars
InteractsWithStrings
InteractsWithDockerComposeServices
HasApiTokens
CalculateChecksumFromStream
Exportable
Importable
MapsCsvSettings
RegistersEventListeners
RemembersChunkOffset
RemembersRowNumber
SkipsErrors
SkipsFailures
WithConditionalSheets
WithModelStub
DelegatedMacroable
HasEventBus
ExtendedQueueable
ProxyFailures
RegistersCustomConcerns
Assertions
Tempfile
Util
MockeryPHPUnitIntegration
Integrates Mockery into PHPUnit. Ensures Mockery expectations are verified for each test and are included by the assertion counter.
MockeryPHPUnitIntegrationAssertPostConditions
MockeryTestCaseSetUp
FormattableHandlerTrait
Helper trait for implementing FormattableInterface
ProcessableHandlerTrait
Helper trait for implementing ProcessableInterface
WebRequestRecognizerTrait
Boundaries
Trait Boundaries.
Cast
Trait Cast.
Comparison
Trait Comparison.
Converter
Trait Converter.
Creator
Trait Creator.
Date
A simple API extension for DateTime.
DeprecatedProperties
Difference
Trait Difference.
IntervalRounding
Trait to call rounding methods to interval or the interval of a period.
IntervalStep
Localization
Trait Localization.
Macro
Trait Macros.
MagicParameter
Trait MagicParameter.
Mixin
Trait Mixin.
Modifiers
Trait Modifiers.
Mutability
Trait Mutability.
ObjectInitialisation
Options
Trait Options.
Rounding
Trait Rounding.
Serialization
Trait Serialization.
Test
Timestamp
Trait Timestamp.
ToStringFormat
Trait ToStringFormat.
Units
Trait Units.
Week
Trait Week.
SmartObject
Strict class for better experience.
StaticClass
Static class.
ArrayEnabled
LoggerAwareTrait
Basic Implementation of LoggerAwareInterface.
LoggerTrait
This is a simple Logger trait that classes unable to extend AbstractLogger (because they extend another class, etc) can include.
EventListens
Implementation of a listener.
TypeTrait
Provides functionality to check values for specific types.
ValueExtractorTrait
Provides functionality to extract the value of a property or method from an object.
ValueToStringTrait
Provides functionality to express a value as string
DeprecatedUuidMethodsTrait
This trait encapsulates deprecated methods for ramsey/uuid; this trait and its methods will be removed in ramsey/uuid 5.0.0.
SerializableFieldsTrait
Provides common serialization functionality to fields
MaxTrait
Provides common functionality for max UUIDs
NilTrait
Provides common functionality for nil UUIDs
TimeTrait
Provides common functionality for getting the time from a time-based UUID
VariantTrait
Provides common functionality for handling the variant, as defined by RFC 4122
VersionTrait
Provides common functionality for handling the version, as defined by RFC 4122
IsProvidedByFlare
HasContext
UsesTime
CacheTrait
An implementation of CacheInterface for PSR-6 CacheItemPoolInterface classes.
LockableTrait
Basic lock feature for commands.
TesterTrait
AddTrait
RouteTrait
ServiceLocatorTrait
A trait to help implement ServiceProviderInterface.
ServiceMethodsSubscriberTrait
Implementation of ServiceSubscriberInterface that determines subscribed services from methods that have the #[SubscribedService] attribute.
ServiceSubscriberTrait
Implementation of ServiceSubscriberInterface that determines subscribed services from methods that have the #[SubscribedService] attribute.
TranslatorTrait
A trait to help implement TranslatorInterface and LocaleAwareInterface.
VarDumperTestTrait
LazyGhostTrait
LazyProxyTrait
Mixin
This trait provides nurllOr*, all* and allNullOr* variants of assertion base methods.
OperationTrait
ParameterTrait
AnnotationTrait
DocblockTrait
MergePropertiesTrait
Steps: 1. Determine direct parent / interfaces / traits 2. With each: - traverse up inheritance tree - inherit from first with schema; all other with scheme can be ignored - merge from all without schema => update all $ref that might reference a property merged.
RefTrait
TypesTrait

Enums

CalendarColor
CalendarStatus
CalendarType
ContractType
NotificationType
RoleEnum
TaskStatus
UserTypeEnum
RoundingMode
Specifies a rounding behavior for numerical operations capable of discarding precision.
ParameterValueType
CompressionMethod
OperationMode
ZipStream execution operation modes
Version
Level
Represents the log levels
Sort
Collection sorting
AnsiColorMode
Requirement
TruncateMode

Constants

ARTISAN_BINARY  = 'artisan'
DS  = '/'
FILTER_VALIDATE_BOOL  = \FILTER_VALIDATE_BOOLEAN
GENERATOR_BASE  = __DIR__
GLOBAL_FUNCTIONS_FILE  = \HAMCREST_BASE . \DIRECTORY_SEPARATOR . 'Hamcrest.php'
GRAPHEME_EXTR_COUNT  = 0
GRAPHEME_EXTR_COUNT  = 0
GRAPHEME_EXTR_MAXBYTES  = 1
GRAPHEME_EXTR_MAXBYTES  = 1
GRAPHEME_EXTR_MAXCHARS  = 2
GRAPHEME_EXTR_MAXCHARS  = 2
HAMCREST_BASE  = \realpath(\dirname(\GENERATOR_BASE) . \DIRECTORY_SEPARATOR . 'hamcrest')
HTMLPURIFIER_PREFIX  = \realpath(\dirname(__FILE__) . '/..')
HTMLPURIFIER_PREFIX  = \dirname(__FILE__)
IDNA_ALLOW_UNASSIGNED  = 1
IDNA_ALLOW_UNASSIGNED  = 1
IDNA_CHECK_BIDI  = 4
IDNA_CHECK_BIDI  = 4
IDNA_CHECK_CONTEXTJ  = 8
IDNA_CHECK_CONTEXTJ  = 8
IDNA_DEFAULT  = 0
IDNA_DEFAULT  = 0
IDNA_ERROR_BIDI  = 2048
IDNA_ERROR_BIDI  = 2048
IDNA_ERROR_CONTEXTJ  = 4096
IDNA_ERROR_CONTEXTJ  = 4096
IDNA_ERROR_DISALLOWED  = 128
IDNA_ERROR_DISALLOWED  = 128
IDNA_ERROR_DOMAIN_NAME_TOO_LONG  = 4
IDNA_ERROR_DOMAIN_NAME_TOO_LONG  = 4
IDNA_ERROR_EMPTY_LABEL  = 1
IDNA_ERROR_EMPTY_LABEL  = 1
IDNA_ERROR_HYPHEN_3_4  = 32
IDNA_ERROR_HYPHEN_3_4  = 32
IDNA_ERROR_INVALID_ACE_LABEL  = 1024
IDNA_ERROR_INVALID_ACE_LABEL  = 1024
IDNA_ERROR_LABEL_HAS_DOT  = 512
IDNA_ERROR_LABEL_HAS_DOT  = 512
IDNA_ERROR_LABEL_TOO_LONG  = 2
IDNA_ERROR_LABEL_TOO_LONG  = 2
IDNA_ERROR_LEADING_COMBINING_MARK  = 64
IDNA_ERROR_LEADING_COMBINING_MARK  = 64
IDNA_ERROR_LEADING_HYPHEN  = 8
IDNA_ERROR_LEADING_HYPHEN  = 8
IDNA_ERROR_PUNYCODE  = 256
IDNA_ERROR_PUNYCODE  = 256
IDNA_ERROR_TRAILING_HYPHEN  = 16
IDNA_ERROR_TRAILING_HYPHEN  = 16
IDNA_NONTRANSITIONAL_TO_ASCII  = 16
IDNA_NONTRANSITIONAL_TO_ASCII  = 16
IDNA_NONTRANSITIONAL_TO_UNICODE  = 32
IDNA_NONTRANSITIONAL_TO_UNICODE  = 32
IDNA_USE_STD3_RULES  = 2
IDNA_USE_STD3_RULES  = 2
INTL_IDNA_VARIANT_2003  = 0
INTL_IDNA_VARIANT_UTS46  = 1
INTL_IDNA_VARIANT_UTS46  = 1
LARAVEL_START  = \microtime(\true)
MB_CASE_LOWER  = 1
MB_CASE_LOWER  = 1
MB_CASE_TITLE  = 2
MB_CASE_TITLE  = 2
MB_CASE_UPPER  = 0
MB_CASE_UPPER  = 0
STATIC_MATCHERS_FILE  = \HAMCREST_BASE . \DIRECTORY_SEPARATOR . 'Hamcrest' . \DIRECTORY_SEPARATOR . 'Matchers.php'
SYMFONY_GRAPHEME_CLUSTER_RX  = ((float) \PCRE_VERSION < 10 ? (float) \PCRE_VERSION >= 8.32 : (float) \PCRE_VERSION >= 10.39) ? '\X' : \Symfony\Polyfill\Intl\Grapheme\Grapheme::GRAPHEME_CLUSTER_RX
U_IDNA_ACE_PREFIX_ERROR  = 66564
U_IDNA_ACE_PREFIX_ERROR  = 66564
U_IDNA_CHECK_BIDI_ERROR  = 66562
U_IDNA_CHECK_BIDI_ERROR  = 66562
U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR  = 66568
U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR  = 66568
U_IDNA_ERROR_LIMIT  = 66569
U_IDNA_ERROR_LIMIT  = 66569
U_IDNA_ERROR_START  = 66560
U_IDNA_ERROR_START  = 66560
U_IDNA_LABEL_TOO_LONG_ERROR  = 66566
U_IDNA_LABEL_TOO_LONG_ERROR  = 66566
U_IDNA_PROHIBITED_ERROR  = 66560
U_IDNA_PROHIBITED_ERROR  = 66560
U_IDNA_STD3_ASCII_RULES_ERROR  = 66563
U_IDNA_STD3_ASCII_RULES_ERROR  = 66563
U_IDNA_UNASSIGNED_ERROR  = 66561
U_IDNA_UNASSIGNED_ERROR  = 66561
U_IDNA_VERIFICATION_ERROR  = 66565
U_IDNA_VERIFICATION_ERROR  = 66565
U_IDNA_ZERO_LENGTH_LABEL_ERROR  = 66567
U_IDNA_ZERO_LENGTH_LABEL_ERROR  = 66567
U_STRINGPREP_CHECK_BIDI_ERROR  = 66562
U_STRINGPREP_CHECK_BIDI_ERROR  = 66562
U_STRINGPREP_PROHIBITED_ERROR  = 66560
U_STRINGPREP_PROHIBITED_ERROR  = 66560
U_STRINGPREP_UNASSIGNED_ERROR  = 66561
U_STRINGPREP_UNASSIGNED_ERROR  = 66561
UUID_TYPE_DCE  = 4
UUID_TYPE_DCE  = 4
UUID_TYPE_DEFAULT  = 0
UUID_TYPE_DEFAULT  = 0
UUID_TYPE_INVALID  = -42
UUID_TYPE_INVALID  = -42
UUID_TYPE_MD5  = 3
UUID_TYPE_MD5  = 3
UUID_TYPE_NAME  = 1
UUID_TYPE_NAME  = 1
UUID_TYPE_NULL  = -1
UUID_TYPE_NULL  = -1
UUID_TYPE_RANDOM  = 4
UUID_TYPE_RANDOM  = 4
UUID_TYPE_SHA1  = 5
UUID_TYPE_SHA1  = 5
UUID_TYPE_TIME  = 1
UUID_TYPE_TIME  = 1
UUID_VARIANT_DCE  = 1
UUID_VARIANT_DCE  = 1
UUID_VARIANT_MICROSOFT  = 2
UUID_VARIANT_MICROSOFT  = 2
UUID_VARIANT_NCS  = 0
UUID_VARIANT_NCS  = 0
UUID_VARIANT_OTHER  = 3
UUID_VARIANT_OTHER  = 3

Functions

status_label()  : string
Get the translated label for a TaskStatus enum value.
swagger_ui_dist_path()  : string
Returns swagger-ui composer dist path.
l5_swagger_asset()  : string
Returns asset from swagger-ui composer package.
htmlpurifier_filter_extractstyleblocks_muteerrorhandler()  : mixed
HTMLPurifier()  : string
Purify HTML.
kses()  : mixed
check_digit()  : int
Calculates one MOD 11 check digit based on customary Brazilian algorithms.
oauth2client_php_autoload()  : mixed
flock()  : mixed
fopen()  : mixed
sem_acquire()  : mixed
sem_release()  : mixed
sem_get()  : mixed
document()  : mixed
getArgs()  : mixed
executeProbes()  : mixed
main()  : mixed
hardAssert()  : mixed
hardAssertIfStatusOk()  : mixed
microtime_float()  : mixed
sessionManagement()  : mixed
executeSql()  : mixed
read()  : mixed
transaction()  : mixed
partition()  : mixed
camel2underscore()  : mixed
describe_type()  : string
Debug function used to describe the provided value type and class.
headers_from_lines()  : array<string|int, mixed>
Parses an array of header lines into an associative array of headers.
debug_resource()  : resource
Returns a debug stream based on the provided variable.
choose_handler()  : callable(RequestInterface, array<string|int, mixed>): PromiseInterface
Chooses and creates a default handler to use based on the environment.
default_user_agent()  : string
Get the default User-Agent string to use with Guzzle.
default_ca_bundle()  : string
Returns the default cacert bundle for the current system.
normalize_header_keys()  : array<string|int, mixed>
Creates an associative array of lowercase header names to the actual header casing.
is_host_in_noproxy()  : bool
Returns true if the provided host matches any of the no proxy areas.
json_decode()  : object|array<string|int, mixed>|string|int|float|bool|null
Wrapper for json_decode that throws when an error occurs.
json_encode()  : string
Wrapper for JSON encoding that throws when an error occurs.
assertThat()  : mixed
Make an assertion and throw {@link Hamcrest_AssertionError} if it fails.
anArray()  : mixed
Evaluates to true only if each $matcher[$i] is satisfied by $array[$i].
hasItemInArray()  : IsArrayContaining
Evaluates to true if any item in an array satisfies the given matcher.
hasValue()  : IsArrayContaining
Evaluates to true if any item in an array satisfies the given matcher.
arrayContainingInAnyOrder()  : mixed
An array with elements that match the given matchers.
containsInAnyOrder()  : mixed
An array with elements that match the given matchers.
arrayContaining()  : mixed
An array with elements that match the given matchers in the same order.
contains()  : mixed
An array with elements that match the given matchers in the same order.
hasKeyInArray()  : IsArrayContainingKey
Evaluates to true if any key in an array matches the given matcher.
hasKey()  : IsArrayContainingKey
Evaluates to true if any key in an array matches the given matcher.
hasKeyValuePair()  : mixed
Test if an array has both an key and value in parity with each other.
hasEntry()  : mixed
Test if an array has both an key and value in parity with each other.
arrayWithSize()  : IsArrayWithSize
Does array size satisfy a given matcher?
emptyArray()  : mixed
Matches an empty array.
nonEmptyArray()  : mixed
Matches an empty array.
emptyTraversable()  : mixed
Returns true if traversable is empty.
nonEmptyTraversable()  : mixed
Returns true if traversable is not empty.
traversableWithSize()  : mixed
Does traversable size satisfy a given matcher?
allOf()  : mixed
Evaluates to true only if ALL of the passed in matchers evaluate to true.
anyOf()  : mixed
Evaluates to true if ANY of the passed in matchers evaluate to true.
noneOf()  : mixed
Evaluates to false if ANY of the passed in matchers evaluate to true.
both()  : mixed
This is useful for fluently combining matchers that must both pass.
either()  : mixed
This is useful for fluently combining matchers where either may pass, for example: <pre> assertThat($string, either(containsString("a"))->orElse(containsString("b"))); </pre>
describedAs()  : mixed
Wraps an existing matcher and overrides the description when it fails.
everyItem()  : Every
hasToString()  : mixed
Does array size satisfy a given matcher?
is()  : mixed
Decorates another Matcher, retaining the behavior but allowing tests to be slightly more expressive.
anything()  : IsAnything
This matcher always evaluates to true.
hasItem()  : mixed
Test if the value is an array containing this matcher.
hasItems()  : mixed
Test if the value is an array containing elements that match all of these matchers.
equalTo()  : mixed
Is the value equal to another value, as tested by the use of the "==" comparison operator?
identicalTo()  : mixed
Tests of the value is identical to $value as tested by the "===" operator.
anInstanceOf()  : mixed
Is the value an instance of a particular type? This version assumes no relationship between the required type and the signature of the method that sets it up, for example in <code>assertThat($anObject, anInstanceOf('Thing'));</code>
any()  : mixed
Is the value an instance of a particular type? This version assumes no relationship between the required type and the signature of the method that sets it up, for example in <code>assertThat($anObject, anInstanceOf('Thing'));</code>
not()  : mixed
Matches if value does not match $value.
nullValue()  : mixed
Matches if value is null.
notNullValue()  : mixed
Matches if value is not null.
sameInstance()  : IsSame
Creates a new instance of IsSame.
typeOf()  : mixed
Is the value a particular built-in type?
set()  : mixed
Matches if value (class, object, or array) has named $property.
notSet()  : mixed
Matches if value (class, object, or array) does not have named $property.
closeTo()  : mixed
Matches if value is a number equal to $value within some range of acceptable error $delta.
comparesEqualTo()  : mixed
The value is not > $value, nor < $value.
greaterThan()  : mixed
The value is > $value.
greaterThanOrEqualTo()  : mixed
The value is >= $value.
atLeast()  : mixed
The value is >= $value.
lessThan()  : mixed
The value is < $value.
lessThanOrEqualTo()  : mixed
The value is <= $value.
atMost()  : mixed
The value is <= $value.
isEmptyString()  : mixed
Matches if value is a zero-length string.
emptyString()  : mixed
Matches if value is a zero-length string.
isEmptyOrNullString()  : mixed
Matches if value is null or a zero-length string.
nullOrEmptyString()  : mixed
Matches if value is null or a zero-length string.
isNonEmptyString()  : mixed
Matches if value is a non-zero-length string.
nonEmptyString()  : mixed
Matches if value is a non-zero-length string.
equalToIgnoringCase()  : mixed
Matches if value is a string equal to $string, regardless of the case.
equalToIgnoringWhiteSpace()  : mixed
Matches if value is a string equal to $string, regardless of whitespace.
matchesPattern()  : mixed
Matches if value is a string that matches regular expression $pattern.
containsString()  : mixed
Matches if value is a string that contains $substring.
containsStringIgnoringCase()  : mixed
Matches if value is a string that contains $substring regardless of the case.
stringContainsInOrder()  : mixed
Matches if value contains $substrings in a constrained order.
endsWith()  : mixed
Matches if value is a string that ends with $substring.
startsWith()  : mixed
Matches if value is a string that starts with $substring.
arrayValue()  : mixed
Is the value an array?
booleanValue()  : mixed
Is the value a boolean?
boolValue()  : mixed
Is the value a boolean?
callableValue()  : mixed
Is the value callable?
doubleValue()  : mixed
Is the value a float/double?
floatValue()  : mixed
Is the value a float/double?
integerValue()  : mixed
Is the value an integer?
intValue()  : mixed
Is the value an integer?
numericValue()  : mixed
Is the value a numeric?
objectValue()  : mixed
Is the value an object?
anObject()  : mixed
Is the value an object?
resourceValue()  : mixed
Is the value a resource?
scalarValue()  : mixed
Is the value a scalar (boolean, integer, double, or string)?
stringValue()  : mixed
Is the value a string?
hasXPath()  : mixed
Wraps <code>$matcher</code> with {@link Hamcrest\Core\IsEqual) if it's not a matcher and the XPath in <code>count()</code> if it's an integer.
something()  : mixed
something()  : mixed
something()  : mixed
collect()  : Collection<TKey, TValue>
Create a collection from the given value.
data_fill()  : mixed
Fill in data where it's missing.
data_get()  : mixed
Get an item from an array or object using "dot" notation.
data_set()  : mixed
Set an item on an array or object using dot notation.
data_forget()  : mixed
Remove / unset an item from an array or object using "dot" notation.
head()  : mixed
Get the first element of an array. Useful for method chaining.
last()  : mixed
Get the last element from an array.
value()  : mixed
Return the default value of the given value.
queueable()  : QueuedClosure
Create a new queued Closure event listener.
join_paths()  : string
Join the given paths together.
abort()  : never
Throw an HttpException with the given data.
abort_if()  : void
Throw an HttpException with the given data if the given condition is true.
abort_unless()  : void
Throw an HttpException with the given data unless the given condition is true.
action()  : string
Generate the URL to a controller action.
app()  : Application|Application|mixed
Get the available container instance.
app_path()  : string
Get the path to the application folder.
asset()  : string
Generate an asset path for the application.
auth()  : Factory|Guard|StatefulGuard
Get the available auth instance.
back()  : RedirectResponse
Create a new redirect response to the previous location.
base_path()  : string
Get the path to the base of the install.
bcrypt()  : string
Hash the given value against the bcrypt algorithm.
broadcast()  : PendingBroadcast
Begin broadcasting an event.
cache()  : mixed|CacheManager
Get / set the specified cache value.
config()  : mixed|Repository
Get / set the specified configuration value.
config_path()  : string
Get the configuration path.
cookie()  : CookieJar|Cookie
Create a new cookie instance.
csrf_field()  : HtmlString
Generate a CSRF token form field.
csrf_token()  : string
Get the CSRF token value.
database_path()  : string
Get the database path.
decrypt()  : mixed
Decrypt the given value.
dispatch()  : PendingDispatch
Dispatch a job to its appropriate handler.
dispatch_sync()  : mixed
Dispatch a command to its appropriate handler in the current process.
encrypt()  : string
Encrypt the given value.
event()  : array<string|int, mixed>|null
Dispatch an event and call the listeners.
fake()  : Generator
Get a faker instance.
info()  : void
Write some information to the log.
logger()  : LogManager|null
Log a debug message to the logs.
lang_path()  : string
Get the path to the language folder.
logs()  : LogManager|LoggerInterface
Get a log driver instance.
method_field()  : HtmlString
Generate a form field to spoof the HTTP verb used by forms.
mix()  : HtmlString|string
Get the path to a versioned Mix file.
now()  : Carbon
Create a new Carbon instance for the current time.
old()  : mixed
Retrieve an old input item.
policy()  : mixed
Get a policy instance for a given class.
precognitive()  : mixed
Handle a Precognition controller hook.
public_path()  : string
Get the path to the public folder.
redirect()  : Redirector|RedirectResponse
Get an instance of the redirector.
report()  : void
Report an exception.
report_if()  : void
Report an exception if the given condition is true.
report_unless()  : void
Report an exception unless the given condition is true.
request()  : mixed|Request|string|array<string|int, mixed>|null
Get an instance of the current request or an input item from the request.
rescue()  : TRescueValue|TRescueFallback
Catch a potential exception and return a default value.
resolve()  : mixed
Resolve a service from the container.
resource_path()  : string
Get the path to the resources folder.
response()  : Response|ResponseFactory
Return a new response from the application.
route()  : string
Generate the URL to a named route.
secure_asset()  : string
Generate an asset path for the application.
secure_url()  : string
Generate a HTTPS url for the application.
session()  : mixed|Store|SessionManager
Get / set the specified session value.
storage_path()  : string
Get the path to the storage folder.
to_route()  : RedirectResponse
Create a new redirect response to a named route.
today()  : Carbon
Create a new Carbon instance for the current date.
trans()  : Translator|string|array<string|int, mixed>|null
Translate the given message.
trans_choice()  : string
Translates the given message based on a count.
__()  : string|array<string|int, mixed>|null
Translate the given message.
url()  : UrlGenerator|string
Generate a url for the application.
validator()  : Validator|Factory
Create a new Validator instance.
view()  : View|Factory
Get the evaluated view contents for the given view.
append_config()  : array<string|int, mixed>
Assign high numeric IDs to a config item to force appending.
blank()  : bool
Determine if the given value is "blank".
class_basename()  : string
Get the class "basename" of the given object / class.
class_uses_recursive()  : array<string|int, mixed>
Returns all traits used by a class, its parent classes and trait of their traits.
e()  : string
Encode HTML special characters in a string.
env()  : mixed
Gets the value of an environment variable.
filled()  : bool
Determine if a value is "filled".
laravel_cloud()  : bool
Determine if the application is running on Laravel Cloud.
object_get()  : mixed
Get an item from an object using "dot" notation.
optional()  : mixed
Provide access to optional objects.
preg_replace_array()  : string
Replace a given pattern with each value in the array in sequentially.
retry()  : mixed
Retry an operation a given number of times.
str()  : Stringable|mixed
Get a new stringable object from the given string.
tap()  : mixed
Call the given Closure with the given value then return the value.
throw_if()  : mixed
Throw the given exception if the given condition is true.
throw_unless()  : mixed
Throw the given exception unless the given condition is true.
trait_uses_recursive()  : array<string|int, mixed>
Returns all traits used by a trait and its traits.
transform()  : mixed
Transform the given value if it is present.
windows_os()  : bool
Determine whether the current environment is Windows based.
with()  : mixed
Return the given value, optionally passed through the given callback.
text()  : string
Prompt the user for text input.
textarea()  : string
Prompt the user for multiline text input.
password()  : string
Prompt the user for input, hiding the value.
select()  : int|string
Prompt the user to select an option.
multiselect()  : array<string|int, int|string>
Prompt the user to select multiple options.
confirm()  : bool
Prompt the user to confirm an action.
pause()  : bool
Prompt the user to continue or cancel after pausing.
suggest()  : string
Prompt the user for text input with auto-completion.
search()  : int|string
Allow the user to search for an option.
multisearch()  : array<string|int, int|string>
Allow the user to search for multiple option.
spin()  : TReturn
Render a spinner while the given callback is executing.
note()  : void
Display a note.
error()  : void
Display an error.
warning()  : void
Display a warning.
alert()  : void
Display an alert.
info()  : void
Display an informational message.
intro()  : void
Display an introduction.
outro()  : void
Display a closing message.
table()  : void
Display a table.
progress()  : mixed
Display a progress bar.
form()  : FormBuilder
mock()  : LegacyMockInterface|MockInterface|TMock
spy()  : LegacyMockInterface|MockInterface|TSpy
namedMock()  : LegacyMockInterface|MockInterface|TNamedMock
anyArgs()  : AnyArgs
andAnyOtherArgs()  : AndAnyOtherArgs
andAnyOthers()  : AndAnyOtherArgs
runSuite()  : mixed
runCase()  : mixed
search()  : mixed
deep_copy()  : mixed
Deep copies the given value.
getMaxHistoryMonthsByAmount()  : int
getHtmlAttribute()  : string
getOpenCollectiveSponsors()  : string
defineCompatibilityTokens()  : void
renderUsing()  : void
Sets the renderer implementation.
style()  : Style
Creates a new style.
render()  : void
Render HTML to a string.
terminal()  : Terminal
Returns a Terminal instance.
ask()  : mixed
Renders a prompt to the user.
assertArrayHasKey()  : void
Asserts that an array has a specified key.
assertArrayNotHasKey()  : void
Asserts that an array does not have a specified key.
assertIsList()  : void
assertContains()  : void
Asserts that a haystack contains a needle.
assertContainsEquals()  : void
assertNotContains()  : void
Asserts that a haystack does not contain a needle.
assertNotContainsEquals()  : void
assertContainsOnly()  : void
Asserts that a haystack contains only values of a given type.
assertContainsOnlyInstancesOf()  : void
Asserts that a haystack contains only instances of a given class name.
assertNotContainsOnly()  : void
Asserts that a haystack does not contain only values of a given type.
assertCount()  : void
Asserts the number of elements of an array, Countable or Traversable.
assertNotCount()  : void
Asserts the number of elements of an array, Countable or Traversable.
assertEquals()  : void
Asserts that two variables are equal.
assertEqualsCanonicalizing()  : void
Asserts that two variables are equal (canonicalizing).
assertEqualsIgnoringCase()  : void
Asserts that two variables are equal (ignoring case).
assertEqualsWithDelta()  : void
Asserts that two variables are equal (with delta).
assertNotEquals()  : void
Asserts that two variables are not equal.
assertNotEqualsCanonicalizing()  : void
Asserts that two variables are not equal (canonicalizing).
assertNotEqualsIgnoringCase()  : void
Asserts that two variables are not equal (ignoring case).
assertNotEqualsWithDelta()  : void
Asserts that two variables are not equal (with delta).
assertObjectEquals()  : void
assertEmpty()  : void
Asserts that a variable is empty.
assertNotEmpty()  : void
Asserts that a variable is not empty.
assertGreaterThan()  : void
Asserts that a value is greater than another value.
assertGreaterThanOrEqual()  : void
Asserts that a value is greater than or equal to another value.
assertLessThan()  : void
Asserts that a value is smaller than another value.
assertLessThanOrEqual()  : void
Asserts that a value is smaller than or equal to another value.
assertFileEquals()  : void
Asserts that the contents of one file is equal to the contents of another file.
assertFileEqualsCanonicalizing()  : void
Asserts that the contents of one file is equal to the contents of another file (canonicalizing).
assertFileEqualsIgnoringCase()  : void
Asserts that the contents of one file is equal to the contents of another file (ignoring case).
assertFileNotEquals()  : void
Asserts that the contents of one file is not equal to the contents of another file.
assertFileNotEqualsCanonicalizing()  : void
Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).
assertFileNotEqualsIgnoringCase()  : void
Asserts that the contents of one file is not equal to the contents of another file (ignoring case).
assertStringEqualsFile()  : void
Asserts that the contents of a string is equal to the contents of a file.
assertStringEqualsFileCanonicalizing()  : void
Asserts that the contents of a string is equal to the contents of a file (canonicalizing).
assertStringEqualsFileIgnoringCase()  : void
Asserts that the contents of a string is equal to the contents of a file (ignoring case).
assertStringNotEqualsFile()  : void
Asserts that the contents of a string is not equal to the contents of a file.
assertStringNotEqualsFileCanonicalizing()  : void
Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).
assertStringNotEqualsFileIgnoringCase()  : void
Asserts that the contents of a string is not equal to the contents of a file (ignoring case).
assertIsReadable()  : void
Asserts that a file/dir is readable.
assertIsNotReadable()  : void
Asserts that a file/dir exists and is not readable.
assertIsWritable()  : void
Asserts that a file/dir exists and is writable.
assertIsNotWritable()  : void
Asserts that a file/dir exists and is not writable.
assertDirectoryExists()  : void
Asserts that a directory exists.
assertDirectoryDoesNotExist()  : void
Asserts that a directory does not exist.
assertDirectoryIsReadable()  : void
Asserts that a directory exists and is readable.
assertDirectoryIsNotReadable()  : void
Asserts that a directory exists and is not readable.
assertDirectoryIsWritable()  : void
Asserts that a directory exists and is writable.
assertDirectoryIsNotWritable()  : void
Asserts that a directory exists and is not writable.
assertFileExists()  : void
Asserts that a file exists.
assertFileDoesNotExist()  : void
Asserts that a file does not exist.
assertFileIsReadable()  : void
Asserts that a file exists and is readable.
assertFileIsNotReadable()  : void
Asserts that a file exists and is not readable.
assertFileIsWritable()  : void
Asserts that a file exists and is writable.
assertFileIsNotWritable()  : void
Asserts that a file exists and is not writable.
assertTrue()  : void
Asserts that a condition is true.
assertNotTrue()  : void
Asserts that a condition is not true.
assertFalse()  : void
Asserts that a condition is false.
assertNotFalse()  : void
Asserts that a condition is not false.
assertNull()  : void
Asserts that a variable is null.
assertNotNull()  : void
Asserts that a variable is not null.
assertFinite()  : void
Asserts that a variable is finite.
assertInfinite()  : void
Asserts that a variable is infinite.
assertNan()  : void
Asserts that a variable is nan.
assertObjectHasProperty()  : void
Asserts that an object has a specified property.
assertObjectNotHasProperty()  : void
Asserts that an object does not have a specified property.
assertSame()  : void
Asserts that two variables have the same type and value.
assertNotSame()  : void
Asserts that two variables do not have the same type and value.
assertInstanceOf()  : void
Asserts that a variable is of a given type.
assertNotInstanceOf()  : void
Asserts that a variable is not of a given type.
assertIsArray()  : void
Asserts that a variable is of type array.
assertIsBool()  : void
Asserts that a variable is of type bool.
assertIsFloat()  : void
Asserts that a variable is of type float.
assertIsInt()  : void
Asserts that a variable is of type int.
assertIsNumeric()  : void
Asserts that a variable is of type numeric.
assertIsObject()  : void
Asserts that a variable is of type object.
assertIsResource()  : void
Asserts that a variable is of type resource.
assertIsClosedResource()  : void
Asserts that a variable is of type resource and is closed.
assertIsString()  : void
Asserts that a variable is of type string.
assertIsScalar()  : void
Asserts that a variable is of type scalar.
assertIsCallable()  : void
Asserts that a variable is of type callable.
assertIsIterable()  : void
Asserts that a variable is of type iterable.
assertIsNotArray()  : void
Asserts that a variable is not of type array.
assertIsNotBool()  : void
Asserts that a variable is not of type bool.
assertIsNotFloat()  : void
Asserts that a variable is not of type float.
assertIsNotInt()  : void
Asserts that a variable is not of type int.
assertIsNotNumeric()  : void
Asserts that a variable is not of type numeric.
assertIsNotObject()  : void
Asserts that a variable is not of type object.
assertIsNotResource()  : void
Asserts that a variable is not of type resource.
assertIsNotClosedResource()  : void
Asserts that a variable is not of type resource.
assertIsNotString()  : void
Asserts that a variable is not of type string.
assertIsNotScalar()  : void
Asserts that a variable is not of type scalar.
assertIsNotCallable()  : void
Asserts that a variable is not of type callable.
assertIsNotIterable()  : void
Asserts that a variable is not of type iterable.
assertMatchesRegularExpression()  : void
Asserts that a string matches a given regular expression.
assertDoesNotMatchRegularExpression()  : void
Asserts that a string does not match a given regular expression.
assertSameSize()  : void
Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same.
assertNotSameSize()  : void
Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same.
assertStringContainsStringIgnoringLineEndings()  : void
assertStringEqualsStringIgnoringLineEndings()  : void
Asserts that two strings are equal except for line endings.
assertFileMatchesFormat()  : void
Asserts that a string matches a given format string.
assertFileMatchesFormatFile()  : void
Asserts that a string matches a given format string.
assertStringMatchesFormat()  : void
Asserts that a string matches a given format string.
assertStringNotMatchesFormat()  : void
Asserts that a string does not match a given format string.
assertStringMatchesFormatFile()  : void
Asserts that a string matches a given format file.
assertStringNotMatchesFormatFile()  : void
Asserts that a string does not match a given format string.
assertStringStartsWith()  : void
Asserts that a string starts with a given prefix.
assertStringStartsNotWith()  : void
Asserts that a string starts not with a given prefix.
assertStringContainsString()  : void
assertStringContainsStringIgnoringCase()  : void
assertStringNotContainsString()  : void
assertStringNotContainsStringIgnoringCase()  : void
assertStringEndsWith()  : void
Asserts that a string ends with a given suffix.
assertStringEndsNotWith()  : void
Asserts that a string ends not with a given suffix.
assertXmlFileEqualsXmlFile()  : void
Asserts that two XML files are equal.
assertXmlFileNotEqualsXmlFile()  : void
Asserts that two XML files are not equal.
assertXmlStringEqualsXmlFile()  : void
Asserts that two XML documents are equal.
assertXmlStringNotEqualsXmlFile()  : void
Asserts that two XML documents are not equal.
assertXmlStringEqualsXmlString()  : void
Asserts that two XML documents are equal.
assertXmlStringNotEqualsXmlString()  : void
Asserts that two XML documents are not equal.
assertThat()  : void
Evaluates a PHPUnit\Framework\Constraint matcher object.
assertJson()  : void
Asserts that a string is a valid JSON string.
assertJsonStringEqualsJsonString()  : void
Asserts that two given JSON encoded objects or arrays are equal.
assertJsonStringNotEqualsJsonString()  : void
Asserts that two given JSON encoded objects or arrays are not equal.
assertJsonStringEqualsJsonFile()  : void
Asserts that the generated JSON encoded object and the content of the given file are equal.
assertJsonStringNotEqualsJsonFile()  : void
Asserts that the generated JSON encoded object and the content of the given file are not equal.
assertJsonFileEqualsJsonFile()  : void
Asserts that two JSON files are equal.
assertJsonFileNotEqualsJsonFile()  : void
Asserts that two JSON files are not equal.
logicalAnd()  : LogicalAnd
logicalOr()  : LogicalOr
logicalNot()  : LogicalNot
logicalXor()  : LogicalXor
anything()  : IsAnything
isTrue()  : IsTrue
isFalse()  : IsFalse
isJson()  : IsJson
isNull()  : IsNull
isFinite()  : IsFinite
isInfinite()  : IsInfinite
isNan()  : IsNan
containsEqual()  : TraversableContainsEqual
containsIdentical()  : TraversableContainsIdentical
containsOnly()  : TraversableContainsOnly
containsOnlyInstancesOf()  : TraversableContainsOnly
arrayHasKey()  : ArrayHasKey
isList()  : IsList
equalTo()  : IsEqual
equalToCanonicalizing()  : IsEqualCanonicalizing
equalToIgnoringCase()  : IsEqualIgnoringCase
equalToWithDelta()  : IsEqualWithDelta
isEmpty()  : IsEmpty
isWritable()  : IsWritable
isReadable()  : IsReadable
directoryExists()  : DirectoryExists
fileExists()  : FileExists
greaterThan()  : GreaterThan
greaterThanOrEqual()  : LogicalOr
identicalTo()  : IsIdentical
isInstanceOf()  : IsInstanceOf
isType()  : IsType
lessThan()  : LessThan
lessThanOrEqual()  : LogicalOr
matchesRegularExpression()  : RegularExpression
matches()  : StringMatchesFormatDescription
stringStartsWith()  : StringStartsWith
stringContains()  : StringContains
stringEndsWith()  : StringEndsWith
stringEqualsStringIgnoringLineEndings()  : StringEqualsStringIgnoringLineEndings
countOf()  : Count
objectEquals()  : ObjectEquals
callback()  : Callback
any()  : AnyInvokedCount
Returns a matcher that matches when the method is executed zero or more times.
never()  : InvokedCount
Returns a matcher that matches when the method is never executed.
atLeast()  : InvokedAtLeastCount
Returns a matcher that matches when the method is executed at least N times.
atLeastOnce()  : InvokedAtLeastOnce
Returns a matcher that matches when the method is executed at least once.
once()  : InvokedCount
Returns a matcher that matches when the method is executed exactly once.
exactly()  : InvokedCount
Returns a matcher that matches when the method is executed exactly $count times.
atMost()  : InvokedAtMostCount
Returns a matcher that matches when the method is executed at most N times.
returnValue()  : ReturnStub
returnValueMap()  : ReturnValueMap
returnArgument()  : ReturnArgument
returnCallback()  : ReturnCallback
returnSelf()  : ReturnSelf
Returns the current object.
throwException()  : Exception
onConsecutiveCalls()  : ConsecutiveCalls
sh()  : string
Command to return the eval-able code to startup PsySH.
debug()  : array<string|int, mixed>
Invoke a Psy Shell from the current context.
info()  : array<string|int, mixed>|null
Get a bunch of debugging info about the current PsySH environment and configuration.
bin()  : Closure
`psysh` command line executable.
getallheaders()  : mixed
Get all HTTP header key/values as an associative array for the current request.
v1()  : non-empty-string
Returns a version 1 (Gregorian time) UUID from a host ID, sequence number, and the current time
v2()  : non-empty-string
Returns a version 2 (DCE Security) UUID from a local domain, local identifier, host ID, clock sequence, and the current time
v3()  : non-empty-string
Returns a version 3 (name-based) UUID based on the MD5 hash of a namespace ID and a name
v4()  : non-empty-string
Returns a version 4 (random) UUID
v5()  : non-empty-string
Returns a version 5 (name-based) UUID based on the SHA-1 hash of a namespace ID and a name
v6()  : non-empty-string
Returns a version 6 (reordered time) UUID from a host ID, sequence number, and the current time
v7()  : non-empty-string
Returns a version 7 (Unix Epoch time) UUID
v8()  : non-empty-string
Returns a version 8 (custom) UUID
array_merge_recursive_distinct()  : array<int|string, mixed>
ddd()  : mixed
trigger_deprecation()  : void
Triggers a silenced deprecation notice.
ctype_alnum()  : mixed
ctype_alpha()  : mixed
ctype_cntrl()  : mixed
ctype_digit()  : mixed
ctype_graph()  : mixed
ctype_lower()  : mixed
ctype_print()  : mixed
ctype_punct()  : mixed
ctype_space()  : mixed
ctype_upper()  : mixed
ctype_xdigit()  : mixed
ctype_alnum()  : bool
ctype_alpha()  : bool
ctype_cntrl()  : bool
ctype_digit()  : bool
ctype_graph()  : bool
ctype_lower()  : bool
ctype_print()  : bool
ctype_punct()  : bool
ctype_space()  : bool
ctype_upper()  : bool
ctype_xdigit()  : bool
grapheme_extract()  : mixed
grapheme_stripos()  : mixed
grapheme_stristr()  : mixed
grapheme_strlen()  : mixed
grapheme_strpos()  : mixed
grapheme_strripos()  : mixed
grapheme_strrpos()  : mixed
grapheme_strstr()  : mixed
grapheme_substr()  : mixed
grapheme_extract()  : string|false
grapheme_stripos()  : int|false
grapheme_stristr()  : string|false
grapheme_strlen()  : int|false|null
grapheme_strpos()  : int|false
grapheme_strripos()  : int|false
grapheme_strrpos()  : int|false
grapheme_strstr()  : string|false
grapheme_substr()  : string|false
idn_to_ascii()  : mixed
idn_to_utf8()  : mixed
idn_to_ascii()  : string|false
idn_to_utf8()  : string|false
normalizer_is_normalized()  : mixed
normalizer_normalize()  : mixed
normalizer_is_normalized()  : bool
normalizer_normalize()  : string|false
mb_convert_encoding()  : mixed
mb_decode_mimeheader()  : mixed
mb_encode_mimeheader()  : mixed
mb_decode_numericentity()  : mixed
mb_encode_numericentity()  : mixed
mb_convert_case()  : mixed
mb_internal_encoding()  : mixed
mb_language()  : mixed
mb_list_encodings()  : mixed
mb_encoding_aliases()  : mixed
mb_check_encoding()  : mixed
mb_detect_encoding()  : mixed
mb_detect_order()  : mixed
mb_parse_str()  : mixed
mb_strlen()  : mixed
mb_strpos()  : mixed
mb_strtolower()  : mixed
mb_strtoupper()  : mixed
mb_substitute_character()  : mixed
mb_substr()  : mixed
mb_stripos()  : mixed
mb_stristr()  : mixed
mb_strrchr()  : mixed
mb_strrichr()  : mixed
mb_strripos()  : mixed
mb_strrpos()  : mixed
mb_strstr()  : mixed
mb_get_info()  : mixed
mb_http_output()  : mixed
mb_strwidth()  : mixed
mb_substr_count()  : mixed
mb_output_handler()  : mixed
mb_http_input()  : mixed
mb_convert_variables()  : mixed
mb_ord()  : mixed
mb_chr()  : mixed
mb_scrub()  : mixed
mb_str_split()  : mixed
mb_str_pad()  : string
mb_ucfirst()  : string
mb_lcfirst()  : string
mb_trim()  : string
mb_ltrim()  : string
mb_rtrim()  : string
mb_convert_encoding()  : array<string|int, mixed>|string|false
mb_decode_mimeheader()  : string
mb_encode_mimeheader()  : string
mb_decode_numericentity()  : string
mb_encode_numericentity()  : string
mb_convert_case()  : string
mb_internal_encoding()  : string|bool
mb_language()  : string|bool
mb_list_encodings()  : array<string|int, mixed>
mb_encoding_aliases()  : array<string|int, mixed>
mb_check_encoding()  : bool
mb_detect_encoding()  : string|false
mb_detect_order()  : array<string|int, mixed>|bool
mb_parse_str()  : bool
mb_strlen()  : int
mb_strpos()  : int|false
mb_strtolower()  : string
mb_strtoupper()  : string
mb_substitute_character()  : string|int|bool
mb_substr()  : string
mb_stripos()  : int|false
mb_stristr()  : string|false
mb_strrchr()  : string|false
mb_strrichr()  : string|false
mb_strripos()  : int|false
mb_strrpos()  : int|false
mb_strstr()  : string|false
mb_get_info()  : array<string|int, mixed>|string|int|false|null
mb_http_output()  : string|bool
mb_strwidth()  : int
mb_substr_count()  : int
mb_output_handler()  : string
mb_http_input()  : array<string|int, mixed>|string|false
mb_convert_variables()  : string|false
mb_ord()  : int|false
mb_chr()  : string|false
mb_scrub()  : string
mb_str_split()  : array<string|int, mixed>
mb_str_pad()  : string
mb_ucfirst()  : string
mb_lcfirst()  : string
mb_trim()  : string
mb_ltrim()  : string
mb_rtrim()  : string
fdiv()  : float
preg_last_error_msg()  : string
str_contains()  : bool
str_starts_with()  : bool
str_ends_with()  : bool
get_debug_type()  : string
get_resource_id()  : int
json_validate()  : bool
mb_str_pad()  : string
stream_context_set_options()  : bool
str_increment()  : string
str_decrement()  : string
ldap_exop_sync()  : bool
ldap_connect_wallet()  : mixed
ldap_exop_sync()  : bool
ldap_connect_wallet()  : Connection|false
uuid_create()  : mixed
uuid_generate_md5()  : mixed
uuid_generate_sha1()  : mixed
uuid_is_valid()  : mixed
uuid_compare()  : mixed
uuid_is_null()  : mixed
uuid_type()  : mixed
uuid_variant()  : mixed
uuid_time()  : mixed
uuid_mac()  : mixed
uuid_parse()  : mixed
uuid_unparse()  : mixed
uuid_create()  : string
uuid_generate_md5()  : string
uuid_generate_sha1()  : string
uuid_is_valid()  : bool
uuid_compare()  : int
uuid_is_null()  : bool
uuid_type()  : int
uuid_variant()  : int
uuid_time()  : int
uuid_mac()  : string
uuid_parse()  : string
uuid_unparse()  : string
u()  : UnicodeString
b()  : ByteString
s()  : UnicodeString|ByteString
findTranslationFiles()  : array<string|int, mixed>
calculateTranslationStatus()  : array<string|int, mixed>
isTranslationCompleted()  : bool
printTranslationStatus()  : mixed
extractLocaleFromFilePath()  : mixed
extractTranslationKeys()  : array<string|int, mixed>
findTransUnitMismatches()  : array<string|int, mixed>
Check whether the trans-unit id and source match with the base translation.
printTitle()  : mixed
printTable()  : mixed
textColorGreen()  : mixed
textColorRed()  : mixed
textColorNormal()  : mixed
t()  : TranslatableMessage
esc()  : string
dump()  : mixed
dd()  : never

Constants

ARTISAN_BINARY

public mixed ARTISAN_BINARY = 'artisan'

FILTER_VALIDATE_BOOL

public mixed FILTER_VALIDATE_BOOL = \FILTER_VALIDATE_BOOLEAN

GENERATOR_BASE

public mixed GENERATOR_BASE = __DIR__

GLOBAL_FUNCTIONS_FILE

public mixed GLOBAL_FUNCTIONS_FILE = \HAMCREST_BASE . \DIRECTORY_SEPARATOR . 'Hamcrest.php'

GRAPHEME_EXTR_COUNT

public mixed GRAPHEME_EXTR_COUNT = 0

GRAPHEME_EXTR_COUNT

public mixed GRAPHEME_EXTR_COUNT = 0

GRAPHEME_EXTR_MAXBYTES

public mixed GRAPHEME_EXTR_MAXBYTES = 1

GRAPHEME_EXTR_MAXBYTES

public mixed GRAPHEME_EXTR_MAXBYTES = 1

GRAPHEME_EXTR_MAXCHARS

public mixed GRAPHEME_EXTR_MAXCHARS = 2

GRAPHEME_EXTR_MAXCHARS

public mixed GRAPHEME_EXTR_MAXCHARS = 2

HAMCREST_BASE

public mixed HAMCREST_BASE = \realpath(\dirname(\GENERATOR_BASE) . \DIRECTORY_SEPARATOR . 'hamcrest')

HTMLPURIFIER_PREFIX

public mixed HTMLPURIFIER_PREFIX = \realpath(\dirname(__FILE__) . '/..')

IDNA_ALLOW_UNASSIGNED

public mixed IDNA_ALLOW_UNASSIGNED = 1

IDNA_ALLOW_UNASSIGNED

public mixed IDNA_ALLOW_UNASSIGNED = 1

IDNA_CHECK_BIDI

public mixed IDNA_CHECK_BIDI = 4

IDNA_CHECK_CONTEXTJ

public mixed IDNA_CHECK_CONTEXTJ = 8

IDNA_CHECK_CONTEXTJ

public mixed IDNA_CHECK_CONTEXTJ = 8

IDNA_ERROR_BIDI

public mixed IDNA_ERROR_BIDI = 2048

IDNA_ERROR_BIDI

public mixed IDNA_ERROR_BIDI = 2048

IDNA_ERROR_CONTEXTJ

public mixed IDNA_ERROR_CONTEXTJ = 4096

IDNA_ERROR_CONTEXTJ

public mixed IDNA_ERROR_CONTEXTJ = 4096

IDNA_ERROR_DISALLOWED

public mixed IDNA_ERROR_DISALLOWED = 128

IDNA_ERROR_DISALLOWED

public mixed IDNA_ERROR_DISALLOWED = 128

IDNA_ERROR_DOMAIN_NAME_TOO_LONG

public mixed IDNA_ERROR_DOMAIN_NAME_TOO_LONG = 4

IDNA_ERROR_DOMAIN_NAME_TOO_LONG

public mixed IDNA_ERROR_DOMAIN_NAME_TOO_LONG = 4

IDNA_ERROR_EMPTY_LABEL

public mixed IDNA_ERROR_EMPTY_LABEL = 1

IDNA_ERROR_EMPTY_LABEL

public mixed IDNA_ERROR_EMPTY_LABEL = 1

IDNA_ERROR_HYPHEN_3_4

public mixed IDNA_ERROR_HYPHEN_3_4 = 32

IDNA_ERROR_HYPHEN_3_4

public mixed IDNA_ERROR_HYPHEN_3_4 = 32

IDNA_ERROR_INVALID_ACE_LABEL

public mixed IDNA_ERROR_INVALID_ACE_LABEL = 1024

IDNA_ERROR_INVALID_ACE_LABEL

public mixed IDNA_ERROR_INVALID_ACE_LABEL = 1024

IDNA_ERROR_LABEL_HAS_DOT

public mixed IDNA_ERROR_LABEL_HAS_DOT = 512

IDNA_ERROR_LABEL_HAS_DOT

public mixed IDNA_ERROR_LABEL_HAS_DOT = 512

IDNA_ERROR_LABEL_TOO_LONG

public mixed IDNA_ERROR_LABEL_TOO_LONG = 2

IDNA_ERROR_LABEL_TOO_LONG

public mixed IDNA_ERROR_LABEL_TOO_LONG = 2

IDNA_ERROR_LEADING_COMBINING_MARK

public mixed IDNA_ERROR_LEADING_COMBINING_MARK = 64

IDNA_ERROR_LEADING_COMBINING_MARK

public mixed IDNA_ERROR_LEADING_COMBINING_MARK = 64

IDNA_ERROR_LEADING_HYPHEN

public mixed IDNA_ERROR_LEADING_HYPHEN = 8

IDNA_ERROR_LEADING_HYPHEN

public mixed IDNA_ERROR_LEADING_HYPHEN = 8

IDNA_ERROR_PUNYCODE

public mixed IDNA_ERROR_PUNYCODE = 256

IDNA_ERROR_PUNYCODE

public mixed IDNA_ERROR_PUNYCODE = 256

IDNA_ERROR_TRAILING_HYPHEN

public mixed IDNA_ERROR_TRAILING_HYPHEN = 16

IDNA_ERROR_TRAILING_HYPHEN

public mixed IDNA_ERROR_TRAILING_HYPHEN = 16

IDNA_NONTRANSITIONAL_TO_ASCII

public mixed IDNA_NONTRANSITIONAL_TO_ASCII = 16

IDNA_NONTRANSITIONAL_TO_ASCII

public mixed IDNA_NONTRANSITIONAL_TO_ASCII = 16

IDNA_NONTRANSITIONAL_TO_UNICODE

public mixed IDNA_NONTRANSITIONAL_TO_UNICODE = 32

IDNA_NONTRANSITIONAL_TO_UNICODE

public mixed IDNA_NONTRANSITIONAL_TO_UNICODE = 32

IDNA_USE_STD3_RULES

public mixed IDNA_USE_STD3_RULES = 2

IDNA_USE_STD3_RULES

public mixed IDNA_USE_STD3_RULES = 2

INTL_IDNA_VARIANT_2003

public mixed INTL_IDNA_VARIANT_2003 = 0

INTL_IDNA_VARIANT_UTS46

public mixed INTL_IDNA_VARIANT_UTS46 = 1

INTL_IDNA_VARIANT_UTS46

public mixed INTL_IDNA_VARIANT_UTS46 = 1

LARAVEL_START

public mixed LARAVEL_START = \microtime(\true)

MB_CASE_LOWER

public mixed MB_CASE_LOWER = 1

MB_CASE_TITLE

public mixed MB_CASE_TITLE = 2

MB_CASE_UPPER

public mixed MB_CASE_UPPER = 0

STATIC_MATCHERS_FILE

public mixed STATIC_MATCHERS_FILE = \HAMCREST_BASE . \DIRECTORY_SEPARATOR . 'Hamcrest' . \DIRECTORY_SEPARATOR . 'Matchers.php'

SYMFONY_GRAPHEME_CLUSTER_RX

public mixed SYMFONY_GRAPHEME_CLUSTER_RX = ((float) \PCRE_VERSION < 10 ? (float) \PCRE_VERSION >= 8.32 : (float) \PCRE_VERSION >= 10.39) ? '\X' : \Symfony\Polyfill\Intl\Grapheme\Grapheme::GRAPHEME_CLUSTER_RX

U_IDNA_ACE_PREFIX_ERROR

public mixed U_IDNA_ACE_PREFIX_ERROR = 66564

U_IDNA_ACE_PREFIX_ERROR

public mixed U_IDNA_ACE_PREFIX_ERROR = 66564

U_IDNA_CHECK_BIDI_ERROR

public mixed U_IDNA_CHECK_BIDI_ERROR = 66562

U_IDNA_CHECK_BIDI_ERROR

public mixed U_IDNA_CHECK_BIDI_ERROR = 66562

U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR

public mixed U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR = 66568

U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR

public mixed U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR = 66568

U_IDNA_ERROR_LIMIT

public mixed U_IDNA_ERROR_LIMIT = 66569

U_IDNA_ERROR_LIMIT

public mixed U_IDNA_ERROR_LIMIT = 66569

U_IDNA_ERROR_START

public mixed U_IDNA_ERROR_START = 66560

U_IDNA_ERROR_START

public mixed U_IDNA_ERROR_START = 66560

U_IDNA_LABEL_TOO_LONG_ERROR

public mixed U_IDNA_LABEL_TOO_LONG_ERROR = 66566

U_IDNA_LABEL_TOO_LONG_ERROR

public mixed U_IDNA_LABEL_TOO_LONG_ERROR = 66566

U_IDNA_PROHIBITED_ERROR

public mixed U_IDNA_PROHIBITED_ERROR = 66560

U_IDNA_PROHIBITED_ERROR

public mixed U_IDNA_PROHIBITED_ERROR = 66560

U_IDNA_STD3_ASCII_RULES_ERROR

public mixed U_IDNA_STD3_ASCII_RULES_ERROR = 66563

U_IDNA_STD3_ASCII_RULES_ERROR

public mixed U_IDNA_STD3_ASCII_RULES_ERROR = 66563

U_IDNA_UNASSIGNED_ERROR

public mixed U_IDNA_UNASSIGNED_ERROR = 66561

U_IDNA_UNASSIGNED_ERROR

public mixed U_IDNA_UNASSIGNED_ERROR = 66561

U_IDNA_VERIFICATION_ERROR

public mixed U_IDNA_VERIFICATION_ERROR = 66565

U_IDNA_VERIFICATION_ERROR

public mixed U_IDNA_VERIFICATION_ERROR = 66565

U_IDNA_ZERO_LENGTH_LABEL_ERROR

public mixed U_IDNA_ZERO_LENGTH_LABEL_ERROR = 66567

U_IDNA_ZERO_LENGTH_LABEL_ERROR

public mixed U_IDNA_ZERO_LENGTH_LABEL_ERROR = 66567

U_STRINGPREP_CHECK_BIDI_ERROR

public mixed U_STRINGPREP_CHECK_BIDI_ERROR = 66562

U_STRINGPREP_CHECK_BIDI_ERROR

public mixed U_STRINGPREP_CHECK_BIDI_ERROR = 66562

U_STRINGPREP_PROHIBITED_ERROR

public mixed U_STRINGPREP_PROHIBITED_ERROR = 66560

U_STRINGPREP_PROHIBITED_ERROR

public mixed U_STRINGPREP_PROHIBITED_ERROR = 66560

U_STRINGPREP_UNASSIGNED_ERROR

public mixed U_STRINGPREP_UNASSIGNED_ERROR = 66561

U_STRINGPREP_UNASSIGNED_ERROR

public mixed U_STRINGPREP_UNASSIGNED_ERROR = 66561

UUID_TYPE_DCE

public mixed UUID_TYPE_DCE = 4

UUID_TYPE_DEFAULT

public mixed UUID_TYPE_DEFAULT = 0

UUID_TYPE_DEFAULT

public mixed UUID_TYPE_DEFAULT = 0

UUID_TYPE_INVALID

public mixed UUID_TYPE_INVALID = -42

UUID_TYPE_INVALID

public mixed UUID_TYPE_INVALID = -42

UUID_TYPE_MD5

public mixed UUID_TYPE_MD5 = 3

UUID_TYPE_NAME

public mixed UUID_TYPE_NAME = 1

UUID_TYPE_NULL

public mixed UUID_TYPE_NULL = -1

UUID_TYPE_RANDOM

public mixed UUID_TYPE_RANDOM = 4

UUID_TYPE_SHA1

public mixed UUID_TYPE_SHA1 = 5

UUID_TYPE_TIME

public mixed UUID_TYPE_TIME = 1

UUID_VARIANT_DCE

public mixed UUID_VARIANT_DCE = 1

UUID_VARIANT_MICROSOFT

public mixed UUID_VARIANT_MICROSOFT = 2

UUID_VARIANT_MICROSOFT

public mixed UUID_VARIANT_MICROSOFT = 2

UUID_VARIANT_NCS

public mixed UUID_VARIANT_NCS = 0

UUID_VARIANT_OTHER

public mixed UUID_VARIANT_OTHER = 3

UUID_VARIANT_OTHER

public mixed UUID_VARIANT_OTHER = 3

Functions

status_label()

Get the translated label for a TaskStatus enum value.

status_label(string|TaskStatus $status) : string
Parameters
$status : string|TaskStatus
Return values
string

swagger_ui_dist_path()

Returns swagger-ui composer dist path.

swagger_ui_dist_path(string $documentation[, null $asset = null ]) : string
Parameters
$documentation : string
$asset : null = null
Tags
throws
L5SwaggerException
Return values
string

l5_swagger_asset()

Returns asset from swagger-ui composer package.

l5_swagger_asset(string $documentation, mixed $asset) : string
Parameters
$documentation : string
$asset : mixed

string

Tags
throws
L5SwaggerException
Return values
string

htmlpurifier_filter_extractstyleblocks_muteerrorhandler()

htmlpurifier_filter_extractstyleblocks_muteerrorhandler() : mixed

HTMLPurifier()

Purify HTML.

HTMLPurifier(string $html[, mixed $config = null ]) : string
Parameters
$html : string

String HTML to purify

$config : mixed = null

Configuration to use, can be any value accepted by HTMLPurifier_Config::create()

Return values
string

kses()

kses(mixed $string, mixed $allowed_html[, mixed $allowed_protocols = null ]) : mixed
Parameters
$string : mixed
$allowed_html : mixed
$allowed_protocols : mixed = null

oauth2client_php_autoload()

oauth2client_php_autoload(mixed $className) : mixed
Parameters
$className : mixed

flock()

flock(mixed $handle, mixed $type) : mixed
Parameters
$handle : mixed
$type : mixed

fopen()

fopen(mixed $file, mixed $mode) : mixed
Parameters
$file : mixed
$mode : mixed

sem_acquire()

sem_acquire(mixed $id) : mixed
Parameters
$id : mixed

sem_release()

sem_release(mixed $id) : mixed
Parameters
$id : mixed

sem_get()

sem_get(mixed $key) : mixed
Parameters
$key : mixed

document()

document(mixed $client, mixed &$metrics) : mixed
Parameters
$client : mixed
$metrics : mixed

executeProbes()

executeProbes(mixed $api) : mixed
Parameters
$api : mixed

hardAssert()

hardAssert(mixed $value, mixed $error_message) : mixed
Parameters
$value : mixed
$error_message : mixed

hardAssertIfStatusOk()

hardAssertIfStatusOk(mixed $status) : mixed
Parameters
$status : mixed

sessionManagement()

sessionManagement(mixed $client, mixed &$metrics) : mixed
Parameters
$client : mixed
$metrics : mixed

executeSql()

executeSql(mixed $client, mixed &$metrics) : mixed
Parameters
$client : mixed
$metrics : mixed

read()

read(mixed $client, mixed &$metrics) : mixed
Parameters
$client : mixed
$metrics : mixed

transaction()

transaction(mixed $client, mixed &$metrics) : mixed
Parameters
$client : mixed
$metrics : mixed

partition()

partition(mixed $client, mixed &$metrics) : mixed
Parameters
$client : mixed
$metrics : mixed

camel2underscore()

camel2underscore(mixed $input) : mixed
Parameters
$input : mixed

describe_type()

Debug function used to describe the provided value type and class.

describe_type will be removed in guzzlehttp/guzzle:8.0. Use Utils::describeType instead.

describe_type(mixed $input) : string
Parameters
$input : mixed

Any type of variable to describe the type of. This parameter misses a typehint because of that.

Return values
string —

Returns a string containing the type of the variable and if a class is provided, the class name.

headers_from_lines()

Parses an array of header lines into an associative array of headers.

headers_from_lines will be removed in guzzlehttp/guzzle:8.0. Use Utils::headersFromLines instead.

headers_from_lines(iterable<string|int, mixed> $lines) : array<string|int, mixed>
Parameters
$lines : iterable<string|int, mixed>

Header lines array of strings in the following format: "Name: Value"

Return values
array<string|int, mixed>

debug_resource()

Returns a debug stream based on the provided variable.

debug_resource will be removed in guzzlehttp/guzzle:8.0. Use Utils::debugResource instead.

debug_resource([mixed $value = null ]) : resource
Parameters
$value : mixed = null

Optional value

Return values
resource

choose_handler()

Chooses and creates a default handler to use based on the environment.

choose_handler will be removed in guzzlehttp/guzzle:8.0. Use Utils::chooseHandler instead.

choose_handler() : callable(RequestInterface, array<string|int, mixed>): PromiseInterface

The returned handler is not wrapped by any default middlewares.

Tags
throws
RuntimeException

if no viable Handler is available.

Return values
callable(RequestInterface, array<string|int, mixed>): PromiseInterface —

Returns the best handler for the given system.

default_user_agent()

Get the default User-Agent string to use with Guzzle.

default_user_agent will be removed in guzzlehttp/guzzle:8.0. Use Utils::defaultUserAgent instead.

default_user_agent() : string
Return values
string

default_ca_bundle()

Returns the default cacert bundle for the current system.

default_ca_bundle will be removed in guzzlehttp/guzzle:8.0. This function is not needed in PHP 5.6+.

default_ca_bundle() : string

First, the openssl.cafile and curl.cainfo php.ini settings are checked. If those settings are not configured, then the common locations for bundles found on Red Hat, CentOS, Fedora, Ubuntu, Debian, FreeBSD, OS X and Windows are checked. If any of these file locations are found on disk, they will be utilized.

Note: the result of this function is cached for subsequent calls.

Tags
throws
RuntimeException

if no bundle can be found.

Return values
string

normalize_header_keys()

Creates an associative array of lowercase header names to the actual header casing.

normalize_header_keys will be removed in guzzlehttp/guzzle:8.0. Use Utils::normalizeHeaderKeys instead.

normalize_header_keys(array<string|int, mixed> $headers) : array<string|int, mixed>
Parameters
$headers : array<string|int, mixed>
Return values
array<string|int, mixed>

is_host_in_noproxy()

Returns true if the provided host matches any of the no proxy areas.

is_host_in_noproxy will be removed in guzzlehttp/guzzle:8.0. Use Utils::isHostInNoProxy instead.

is_host_in_noproxy(string $host, array<string|int, string> $noProxyArray) : bool

This method will strip a port from the host if it is present. Each pattern can be matched with an exact match (e.g., "foo.com" == "foo.com") or a partial match: (e.g., "foo.com" == "baz.foo.com" and ".foo.com" == "baz.foo.com", but ".foo.com" != "foo.com").

Areas are matched in the following cases:

  1. "*" (without quotes) always matches any hosts.
  2. An exact match.
  3. The area starts with "." and the area is the last part of the host. e.g. '.mit.edu' will match any host that ends with '.mit.edu'.
Parameters
$host : string

Host to check against the patterns.

$noProxyArray : array<string|int, string>

An array of host patterns.

Tags
throws
InvalidArgumentException
Return values
bool

json_decode()

Wrapper for json_decode that throws when an error occurs.

json_decode will be removed in guzzlehttp/guzzle:8.0. Use Utils::jsonDecode instead.

json_decode(string $json[, bool $assoc = false ][, int $depth = 512 ][, int $options = 0 ]) : object|array<string|int, mixed>|string|int|float|bool|null
Parameters
$json : string

JSON data to parse

$assoc : bool = false

When true, returned objects will be converted into associative arrays.

$depth : int = 512

User specified recursion depth.

$options : int = 0

Bitmask of JSON decode options.

Tags
throws
InvalidArgumentException

if the JSON cannot be decoded.

see
https://www.php.net/manual/en/function.json-decode.php
Return values
object|array<string|int, mixed>|string|int|float|bool|null

json_encode()

Wrapper for JSON encoding that throws when an error occurs.

json_encode will be removed in guzzlehttp/guzzle:8.0. Use Utils::jsonEncode instead.

json_encode(mixed $value[, int $options = 0 ][, int $depth = 512 ]) : string
Parameters
$value : mixed

The value being encoded

$options : int = 0

JSON encode option bitmask

$depth : int = 512

Set the maximum depth. Must be greater than zero.

Tags
throws
InvalidArgumentException

if the JSON cannot be encoded.

see
https://www.php.net/manual/en/function.json-encode.php
Return values
string

assertThat()

Make an assertion and throw {@link Hamcrest_AssertionError} if it fails.

assertThat() : mixed

Example:

//With an identifier
assertThat("assertion identifier", $apple->flavour(), equalTo("tasty"));
//Without an identifier
assertThat($apple->flavour(), equalTo("tasty"));
//Evaluating a boolean expression
assertThat("some error", $a > $b);

anArray()

Evaluates to true only if each $matcher[$i] is satisfied by $array[$i].

anArray() : mixed

hasItemInArray()

Evaluates to true if any item in an array satisfies the given matcher.

hasItemInArray(mixed $item) : IsArrayContaining
Parameters
$item : mixed

as a or a value.

Return values
IsArrayContaining

arrayContainingInAnyOrder()

An array with elements that match the given matchers.

arrayContainingInAnyOrder() : mixed

containsInAnyOrder()

An array with elements that match the given matchers.

containsInAnyOrder() : mixed

arrayContaining()

An array with elements that match the given matchers in the same order.

arrayContaining() : mixed

contains()

An array with elements that match the given matchers in the same order.

contains() : mixed

hasKeyValuePair()

Test if an array has both an key and value in parity with each other.

hasKeyValuePair(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed

hasEntry()

Test if an array has both an key and value in parity with each other.

hasEntry(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed

emptyArray()

Matches an empty array.

emptyArray() : mixed

nonEmptyArray()

Matches an empty array.

nonEmptyArray() : mixed

emptyTraversable()

Returns true if traversable is empty.

emptyTraversable() : mixed

nonEmptyTraversable()

Returns true if traversable is not empty.

nonEmptyTraversable() : mixed

traversableWithSize()

Does traversable size satisfy a given matcher?

traversableWithSize(mixed $size) : mixed
Parameters
$size : mixed

allOf()

Evaluates to true only if ALL of the passed in matchers evaluate to true.

allOf() : mixed

anyOf()

Evaluates to true if ANY of the passed in matchers evaluate to true.

anyOf() : mixed

noneOf()

Evaluates to false if ANY of the passed in matchers evaluate to true.

noneOf() : mixed

both()

This is useful for fluently combining matchers that must both pass.

both(Matcher $matcher) : mixed

For example:

  assertThat($string, both(containsString("a"))->andAlso(containsString("b")));
Parameters
$matcher : Matcher

either()

This is useful for fluently combining matchers where either may pass, for example: <pre> assertThat($string, either(containsString("a"))->orElse(containsString("b"))); </pre>

either(Matcher $matcher) : mixed
Parameters
$matcher : Matcher

describedAs()

Wraps an existing matcher and overrides the description when it fails.

describedAs() : mixed

everyItem()

everyItem(Matcher $itemMatcher) : Every
Parameters
$itemMatcher : Matcher

A matcher to apply to every element in an array.

Return values
Every —

Evaluates to TRUE for a collection in which every item matches $itemMatcher

hasToString()

Does array size satisfy a given matcher?

hasToString(mixed $matcher) : mixed
Parameters
$matcher : mixed

is()

Decorates another Matcher, retaining the behavior but allowing tests to be slightly more expressive.

is(mixed $value) : mixed

For example: assertThat($cheese, equalTo($smelly)) vs. assertThat($cheese, is(equalTo($smelly)))

Parameters
$value : mixed

anything()

This matcher always evaluates to true.

anything([string $description = 'ANYTHING' ]) : IsAnything
Parameters
$description : string = 'ANYTHING'

A meaningful string used when describing itself.

Return values
IsAnything

hasItem()

Test if the value is an array containing this matcher.

hasItem() : mixed

Example:

assertThat(array('a', 'b'), hasItem(equalTo('b')));
//Convenience defaults to equalTo()
assertThat(array('a', 'b'), hasItem('b'));

hasItems()

Test if the value is an array containing elements that match all of these matchers.

hasItems() : mixed

Example:

assertThat(array('a', 'b', 'c'), hasItems(equalTo('a'), equalTo('b')));

equalTo()

Is the value equal to another value, as tested by the use of the "==" comparison operator?

equalTo(mixed $item) : mixed
Parameters
$item : mixed

identicalTo()

Tests of the value is identical to $value as tested by the "===" operator.

identicalTo(mixed $value) : mixed
Parameters
$value : mixed

anInstanceOf()

Is the value an instance of a particular type? This version assumes no relationship between the required type and the signature of the method that sets it up, for example in <code>assertThat($anObject, anInstanceOf('Thing'));</code>

anInstanceOf(mixed $theClass) : mixed
Parameters
$theClass : mixed

any()

Is the value an instance of a particular type? This version assumes no relationship between the required type and the signature of the method that sets it up, for example in <code>assertThat($anObject, anInstanceOf('Thing'));</code>

any(mixed $theClass) : mixed
Parameters
$theClass : mixed

not()

Matches if value does not match $value.

not(mixed $value) : mixed
Parameters
$value : mixed

nullValue()

Matches if value is null.

nullValue() : mixed

notNullValue()

Matches if value is not null.

notNullValue() : mixed

sameInstance()

Creates a new instance of IsSame.

sameInstance(mixed $object) : IsSame
Parameters
$object : mixed

The predicate evaluates to true only when the argument is this object.

Return values
IsSame

typeOf()

Is the value a particular built-in type?

typeOf(mixed $theType) : mixed
Parameters
$theType : mixed

set()

Matches if value (class, object, or array) has named $property.

set(mixed $property) : mixed
Parameters
$property : mixed

notSet()

Matches if value (class, object, or array) does not have named $property.

notSet(mixed $property) : mixed
Parameters
$property : mixed

closeTo()

Matches if value is a number equal to $value within some range of acceptable error $delta.

closeTo(mixed $value, mixed $delta) : mixed
Parameters
$value : mixed
$delta : mixed

comparesEqualTo()

The value is not > $value, nor < $value.

comparesEqualTo(mixed $value) : mixed
Parameters
$value : mixed

greaterThan()

The value is > $value.

greaterThan(mixed $value) : mixed
Parameters
$value : mixed

greaterThanOrEqualTo()

The value is >= $value.

greaterThanOrEqualTo(mixed $value) : mixed
Parameters
$value : mixed

atLeast()

The value is >= $value.

atLeast(mixed $value) : mixed
Parameters
$value : mixed

lessThan()

The value is < $value.

lessThan(mixed $value) : mixed
Parameters
$value : mixed

lessThanOrEqualTo()

The value is <= $value.

lessThanOrEqualTo(mixed $value) : mixed
Parameters
$value : mixed

atMost()

The value is <= $value.

atMost(mixed $value) : mixed
Parameters
$value : mixed

isEmptyString()

Matches if value is a zero-length string.

isEmptyString() : mixed

emptyString()

Matches if value is a zero-length string.

emptyString() : mixed

isEmptyOrNullString()

Matches if value is null or a zero-length string.

isEmptyOrNullString() : mixed

nullOrEmptyString()

Matches if value is null or a zero-length string.

nullOrEmptyString() : mixed

isNonEmptyString()

Matches if value is a non-zero-length string.

isNonEmptyString() : mixed

nonEmptyString()

Matches if value is a non-zero-length string.

nonEmptyString() : mixed

equalToIgnoringCase()

Matches if value is a string equal to $string, regardless of the case.

equalToIgnoringCase(mixed $string) : mixed
Parameters
$string : mixed

equalToIgnoringWhiteSpace()

Matches if value is a string equal to $string, regardless of whitespace.

equalToIgnoringWhiteSpace(mixed $string) : mixed
Parameters
$string : mixed

matchesPattern()

Matches if value is a string that matches regular expression $pattern.

matchesPattern(mixed $pattern) : mixed
Parameters
$pattern : mixed

containsString()

Matches if value is a string that contains $substring.

containsString(mixed $substring) : mixed
Parameters
$substring : mixed

containsStringIgnoringCase()

Matches if value is a string that contains $substring regardless of the case.

containsStringIgnoringCase(mixed $substring) : mixed
Parameters
$substring : mixed

stringContainsInOrder()

Matches if value contains $substrings in a constrained order.

stringContainsInOrder() : mixed

endsWith()

Matches if value is a string that ends with $substring.

endsWith(mixed $substring) : mixed
Parameters
$substring : mixed

startsWith()

Matches if value is a string that starts with $substring.

startsWith(mixed $substring) : mixed
Parameters
$substring : mixed

arrayValue()

Is the value an array?

arrayValue() : mixed

booleanValue()

Is the value a boolean?

booleanValue() : mixed

boolValue()

Is the value a boolean?

boolValue() : mixed

callableValue()

Is the value callable?

callableValue() : mixed

doubleValue()

Is the value a float/double?

doubleValue() : mixed

floatValue()

Is the value a float/double?

floatValue() : mixed

integerValue()

Is the value an integer?

integerValue() : mixed

intValue()

Is the value an integer?

intValue() : mixed

numericValue()

Is the value a numeric?

numericValue() : mixed

objectValue()

Is the value an object?

objectValue() : mixed

anObject()

Is the value an object?

anObject() : mixed

resourceValue()

Is the value a resource?

resourceValue() : mixed

scalarValue()

Is the value a scalar (boolean, integer, double, or string)?

scalarValue() : mixed

stringValue()

Is the value a string?

stringValue() : mixed

hasXPath()

Wraps <code>$matcher</code> with {@link Hamcrest\Core\IsEqual) if it's not a matcher and the XPath in <code>count()</code> if it's an integer.

hasXPath(mixed $xpath[, mixed $matcher = null ]) : mixed
Parameters
$xpath : mixed
$matcher : mixed = null

something()

something() : mixed

something()

something() : mixed

something()

something() : mixed

collect()

Create a collection from the given value.

collect([Arrayable<TKey, TValue>|iterable<TKey, TValue>|null $value = [] ]) : Collection<TKey, TValue>
Parameters
$value : Arrayable<TKey, TValue>|iterable<TKey, TValue>|null = []
Tags
template
template
Return values
Collection<TKey, TValue>

data_fill()

Fill in data where it's missing.

data_fill(mixed &$target, string|array<string|int, mixed> $key, mixed $value) : mixed
Parameters
$target : mixed
$key : string|array<string|int, mixed>
$value : mixed

data_get()

Get an item from an array or object using "dot" notation.

data_get(mixed $target, string|array<string|int, mixed>|int|null $key[, mixed $default = null ]) : mixed
Parameters
$target : mixed
$key : string|array<string|int, mixed>|int|null
$default : mixed = null

data_set()

Set an item on an array or object using dot notation.

data_set(mixed &$target, string|array<string|int, mixed> $key, mixed $value[, bool $overwrite = true ]) : mixed
Parameters
$target : mixed
$key : string|array<string|int, mixed>
$value : mixed
$overwrite : bool = true

data_forget()

Remove / unset an item from an array or object using "dot" notation.

data_forget(mixed &$target, string|array<string|int, mixed>|int|null $key) : mixed
Parameters
$target : mixed
$key : string|array<string|int, mixed>|int|null

head()

Get the first element of an array. Useful for method chaining.

head(array<string|int, mixed> $array) : mixed
Parameters
$array : array<string|int, mixed>

last()

Get the last element from an array.

last(array<string|int, mixed> $array) : mixed
Parameters
$array : array<string|int, mixed>

value()

Return the default value of the given value.

value(mixed $value, mixed ...$args) : mixed
Parameters
$value : mixed
$args : mixed

join_paths()

Join the given paths together.

join_paths(string|null $basePath, string ...$paths) : string
Parameters
$basePath : string|null
$paths : string
Return values
string

abort_if()

Throw an HttpException with the given data if the given condition is true.

abort_if(bool $boolean, Response|Responsable|int $code[, string $message = '' ][, array<string|int, mixed> $headers = [] ]) : void
Parameters
$boolean : bool
$code : Response|Responsable|int
$message : string = ''
$headers : array<string|int, mixed> = []
Tags
throws
HttpException
throws
NotFoundHttpException

abort_unless()

Throw an HttpException with the given data unless the given condition is true.

abort_unless(bool $boolean, Response|Responsable|int $code[, string $message = '' ][, array<string|int, mixed> $headers = [] ]) : void
Parameters
$boolean : bool
$code : Response|Responsable|int
$message : string = ''
$headers : array<string|int, mixed> = []
Tags
throws
HttpException
throws
NotFoundHttpException

action()

Generate the URL to a controller action.

action(string|array<string|int, mixed> $name[, mixed $parameters = [] ][, bool $absolute = true ]) : string
Parameters
$name : string|array<string|int, mixed>
$parameters : mixed = []
$absolute : bool = true
Return values
string

app()

Get the available container instance.

app([string|null $abstract = null ][, array<string|int, mixed> $parameters = [] ]) : Application|Application|mixed
Parameters
$abstract : string|null = null
$parameters : array<string|int, mixed> = []
Return values
Application|Application|mixed

app_path()

Get the path to the application folder.

app_path([string $path = '' ]) : string
Parameters
$path : string = ''
Return values
string

asset()

Generate an asset path for the application.

asset(string $path[, bool|null $secure = null ]) : string
Parameters
$path : string
$secure : bool|null = null
Return values
string

back()

Create a new redirect response to the previous location.

back([int $status = 302 ][, array<string|int, mixed> $headers = [] ][, mixed $fallback = false ]) : RedirectResponse
Parameters
$status : int = 302
$headers : array<string|int, mixed> = []
$fallback : mixed = false
Return values
RedirectResponse

base_path()

Get the path to the base of the install.

base_path([string $path = '' ]) : string
Parameters
$path : string = ''
Return values
string

bcrypt()

Hash the given value against the bcrypt algorithm.

bcrypt(string $value[, array<string|int, mixed> $options = [] ]) : string
Parameters
$value : string
$options : array<string|int, mixed> = []
Return values
string

cache()

Get / set the specified cache value.

cache(mixed ...$arguments) : mixed|CacheManager

If an array is passed, we'll assume you want to put to the cache.

Parameters
$arguments : mixed

key|key,default|data,expiration|null

Tags
throws
InvalidArgumentException
Return values
mixed|CacheManager

config()

Get / set the specified configuration value.

config([array<string|int, mixed>|string|null $key = null ][, mixed $default = null ]) : mixed|Repository

If an array is passed as the key, we will assume you want to set an array of values.

Parameters
$key : array<string|int, mixed>|string|null = null
$default : mixed = null
Return values
mixed|Repository

config_path()

Get the configuration path.

config_path([string $path = '' ]) : string
Parameters
$path : string = ''
Return values
string

cookie()

Create a new cookie instance.

cookie([string|null $name = null ][, string|null $value = null ][, int $minutes = 0 ][, string|null $path = null ][, string|null $domain = null ][, bool|null $secure = null ][, bool $httpOnly = true ][, bool $raw = false ][, string|null $sameSite = null ]) : CookieJar|Cookie
Parameters
$name : string|null = null
$value : string|null = null
$minutes : int = 0
$path : string|null = null
$domain : string|null = null
$secure : bool|null = null
$httpOnly : bool = true
$raw : bool = false
$sameSite : string|null = null
Return values
CookieJar|Cookie

csrf_token()

Get the CSRF token value.

csrf_token() : string
Tags
throws
RuntimeException
Return values
string

database_path()

Get the database path.

database_path([string $path = '' ]) : string
Parameters
$path : string = ''
Return values
string

decrypt()

Decrypt the given value.

decrypt(string $value[, bool $unserialize = true ]) : mixed
Parameters
$value : string
$unserialize : bool = true

dispatch_sync()

Dispatch a command to its appropriate handler in the current process.

dispatch_sync(mixed $job[, mixed $handler = null ]) : mixed

Queueable jobs will be dispatched to the "sync" queue.

Parameters
$job : mixed
$handler : mixed = null

encrypt()

Encrypt the given value.

encrypt(mixed $value[, bool $serialize = true ]) : string
Parameters
$value : mixed
$serialize : bool = true
Return values
string

event()

Dispatch an event and call the listeners.

event(mixed ...$args) : array<string|int, mixed>|null
Parameters
$args : mixed
Return values
array<string|int, mixed>|null

fake()

Get a faker instance.

fake([string|null $locale = null ]) : Generator
Parameters
$locale : string|null = null
Return values
Generator

info()

Write some information to the log.

info(string $message[, array<string|int, mixed> $context = [] ]) : void
Parameters
$message : string
$context : array<string|int, mixed> = []

logger()

Log a debug message to the logs.

logger([string|null $message = null ][, array<string|int, mixed> $context = [] ]) : LogManager|null
Parameters
$message : string|null = null
$context : array<string|int, mixed> = []
Return values
LogManager|null

lang_path()

Get the path to the language folder.

lang_path([string $path = '' ]) : string
Parameters
$path : string = ''
Return values
string

method_field()

Generate a form field to spoof the HTTP verb used by forms.

method_field(string $method) : HtmlString
Parameters
$method : string
Return values
HtmlString

mix()

Get the path to a versioned Mix file.

mix(string $path[, string $manifestDirectory = '' ]) : HtmlString|string
Parameters
$path : string
$manifestDirectory : string = ''
Tags
throws
Exception
Return values
HtmlString|string

now()

Create a new Carbon instance for the current time.

now([DateTimeZone|string|null $tz = null ]) : Carbon
Parameters
$tz : DateTimeZone|string|null = null
Return values
Carbon

old()

Retrieve an old input item.

old([string|null $key = null ][, mixed $default = null ]) : mixed
Parameters
$key : string|null = null
$default : mixed = null

policy()

Get a policy instance for a given class.

policy(object|string $class) : mixed
Parameters
$class : object|string
Tags
throws
InvalidArgumentException

precognitive()

Handle a Precognition controller hook.

precognitive([null|callable $callable = null ]) : mixed
Parameters
$callable : null|callable = null

public_path()

Get the path to the public folder.

public_path([string $path = '' ]) : string
Parameters
$path : string = ''
Return values
string

redirect()

Get an instance of the redirector.

redirect([string|null $to = null ][, int $status = 302 ][, array<string|int, mixed> $headers = [] ][, bool|null $secure = null ]) : Redirector|RedirectResponse
Parameters
$to : string|null = null
$status : int = 302
$headers : array<string|int, mixed> = []
$secure : bool|null = null
Return values
Redirector|RedirectResponse

report()

Report an exception.

report(Throwable|string $exception) : void
Parameters
$exception : Throwable|string

report_if()

Report an exception if the given condition is true.

report_if(bool $boolean, Throwable|string $exception) : void
Parameters
$boolean : bool
$exception : Throwable|string

report_unless()

Report an exception unless the given condition is true.

report_unless(bool $boolean, Throwable|string $exception) : void
Parameters
$boolean : bool
$exception : Throwable|string

request()

Get an instance of the current request or an input item from the request.

request([array<string|int, mixed>|string|null $key = null ][, mixed $default = null ]) : mixed|Request|string|array<string|int, mixed>|null
Parameters
$key : array<string|int, mixed>|string|null = null
$default : mixed = null
Return values
mixed|Request|string|array<string|int, mixed>|null

rescue()

Catch a potential exception and return a default value.

rescue(callable(): TRescueValue $callback[, callable(Throwable): TRescueFallback|TRescueFallback $rescue = null ][, bool|callable $report = true ]) : TRescueValue|TRescueFallback
Parameters
$callback : callable(): TRescueValue
$rescue : callable(Throwable): TRescueFallback|TRescueFallback = null
$report : bool|callable = true
Tags
template
template
Return values
TRescueValue|TRescueFallback

resolve()

Resolve a service from the container.

resolve(string $name[, array<string|int, mixed> $parameters = [] ]) : mixed
Parameters
$name : string
$parameters : array<string|int, mixed> = []

resource_path()

Get the path to the resources folder.

resource_path([string $path = '' ]) : string
Parameters
$path : string = ''
Return values
string

response()

Return a new response from the application.

response([View|string|array<string|int, mixed>|null $content = '' ][, int $status = 200 ][, array<string|int, mixed> $headers = [] ]) : Response|ResponseFactory
Parameters
$content : View|string|array<string|int, mixed>|null = ''
$status : int = 200
$headers : array<string|int, mixed> = []
Return values
Response|ResponseFactory

route()

Generate the URL to a named route.

route(string $name[, mixed $parameters = [] ][, bool $absolute = true ]) : string
Parameters
$name : string
$parameters : mixed = []
$absolute : bool = true
Return values
string

secure_asset()

Generate an asset path for the application.

secure_asset(string $path) : string
Parameters
$path : string
Return values
string

secure_url()

Generate a HTTPS url for the application.

secure_url(string $path[, mixed $parameters = [] ]) : string
Parameters
$path : string
$parameters : mixed = []
Return values
string

session()

Get / set the specified session value.

session([array<string|int, mixed>|string|null $key = null ][, mixed $default = null ]) : mixed|Store|SessionManager

If an array is passed as the key, we will assume you want to set an array of values.

Parameters
$key : array<string|int, mixed>|string|null = null
$default : mixed = null
Return values
mixed|Store|SessionManager

storage_path()

Get the path to the storage folder.

storage_path([string $path = '' ]) : string
Parameters
$path : string = ''
Return values
string

to_route()

Create a new redirect response to a named route.

to_route(string $route[, mixed $parameters = [] ][, int $status = 302 ][, array<string|int, mixed> $headers = [] ]) : RedirectResponse
Parameters
$route : string
$parameters : mixed = []
$status : int = 302
$headers : array<string|int, mixed> = []
Return values
RedirectResponse

today()

Create a new Carbon instance for the current date.

today([DateTimeZone|string|null $tz = null ]) : Carbon
Parameters
$tz : DateTimeZone|string|null = null
Return values
Carbon

trans()

Translate the given message.

trans([string|null $key = null ][, array<string|int, mixed> $replace = [] ][, string|null $locale = null ]) : Translator|string|array<string|int, mixed>|null
Parameters
$key : string|null = null
$replace : array<string|int, mixed> = []
$locale : string|null = null
Return values
Translator|string|array<string|int, mixed>|null

trans_choice()

Translates the given message based on a count.

trans_choice(string $key, Countable|int|float|array<string|int, mixed> $number[, array<string|int, mixed> $replace = [] ][, string|null $locale = null ]) : string
Parameters
$key : string
$number : Countable|int|float|array<string|int, mixed>
$replace : array<string|int, mixed> = []
$locale : string|null = null
Return values
string

__()

Translate the given message.

__([string|null $key = null ][, array<string|int, mixed> $replace = [] ][, string|null $locale = null ]) : string|array<string|int, mixed>|null
Parameters
$key : string|null = null
$replace : array<string|int, mixed> = []
$locale : string|null = null
Return values
string|array<string|int, mixed>|null

url()

Generate a url for the application.

url([string|null $path = null ][, mixed $parameters = [] ][, bool|null $secure = null ]) : UrlGenerator|string
Parameters
$path : string|null = null
$parameters : mixed = []
$secure : bool|null = null
Return values
UrlGenerator|string

validator()

Create a new Validator instance.

validator([array<string|int, mixed> $data = [] ][, array<string|int, mixed> $rules = [] ][, array<string|int, mixed> $messages = [] ][, array<string|int, mixed> $attributes = [] ]) : Validator|Factory
Parameters
$data : array<string|int, mixed> = []
$rules : array<string|int, mixed> = []
$messages : array<string|int, mixed> = []
$attributes : array<string|int, mixed> = []
Return values
Validator|Factory

view()

Get the evaluated view contents for the given view.

view([string|null $view = null ][, Arrayable|array<string|int, mixed> $data = [] ][, array<string|int, mixed> $mergeData = [] ]) : View|Factory
Parameters
$view : string|null = null
$data : Arrayable|array<string|int, mixed> = []
$mergeData : array<string|int, mixed> = []
Return values
View|Factory

append_config()

Assign high numeric IDs to a config item to force appending.

append_config(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
Return values
array<string|int, mixed>

blank()

Determine if the given value is "blank".

blank(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

class_basename()

Get the class "basename" of the given object / class.

class_basename(string|object $class) : string
Parameters
$class : string|object
Return values
string

class_uses_recursive()

Returns all traits used by a class, its parent classes and trait of their traits.

class_uses_recursive(object|string $class) : array<string|int, mixed>
Parameters
$class : object|string
Return values
array<string|int, mixed>

env()

Gets the value of an environment variable.

env(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string
$default : mixed = null

filled()

Determine if a value is "filled".

filled(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

laravel_cloud()

Determine if the application is running on Laravel Cloud.

laravel_cloud() : bool
Return values
bool

object_get()

Get an item from an object using "dot" notation.

object_get(object $object, string|null $key[, mixed $default = null ]) : mixed
Parameters
$object : object
$key : string|null
$default : mixed = null

optional()

Provide access to optional objects.

optional([mixed $value = null ][, callable|null $callback = null ]) : mixed
Parameters
$value : mixed = null
$callback : callable|null = null

preg_replace_array()

Replace a given pattern with each value in the array in sequentially.

preg_replace_array(string $pattern, array<string|int, mixed> $replacements, string $subject) : string
Parameters
$pattern : string
$replacements : array<string|int, mixed>
$subject : string
Return values
string

retry()

Retry an operation a given number of times.

retry(int|array<string|int, mixed> $times, callable $callback[, int|Closure $sleepMilliseconds = 0 ][, callable|null $when = null ]) : mixed
Parameters
$times : int|array<string|int, mixed>
$callback : callable
$sleepMilliseconds : int|Closure = 0
$when : callable|null = null
Tags
throws
Exception

str()

Get a new stringable object from the given string.

str([string|null $string = null ]) : Stringable|mixed
Parameters
$string : string|null = null
Return values
Stringable|mixed

tap()

Call the given Closure with the given value then return the value.

tap(mixed $value[, callable|null $callback = null ]) : mixed
Parameters
$value : mixed
$callback : callable|null = null

throw_if()

Throw the given exception if the given condition is true.

throw_if(mixed $condition[, TException|TException>|string $exception = 'RuntimeException' ], mixed ...$parameters) : mixed
Parameters
$condition : mixed
$exception : TException|TException>|string = 'RuntimeException'
$parameters : mixed
Tags
template
throws
TException

throw_unless()

Throw the given exception unless the given condition is true.

throw_unless(mixed $condition[, TException|TException>|string $exception = 'RuntimeException' ], mixed ...$parameters) : mixed
Parameters
$condition : mixed
$exception : TException|TException>|string = 'RuntimeException'
$parameters : mixed
Tags
template
throws
TException

trait_uses_recursive()

Returns all traits used by a trait and its traits.

trait_uses_recursive(object|string $trait) : array<string|int, mixed>
Parameters
$trait : object|string
Return values
array<string|int, mixed>

transform()

Transform the given value if it is present.

transform(TValue $value, callable(TValue): TReturn $callback[, TDefault|callable(TValue): TDefault|null $default = null ]) : mixed
Parameters
$value : TValue
$callback : callable(TValue): TReturn
$default : TDefault|callable(TValue): TDefault|null = null
Tags
template
template
template

windows_os()

Determine whether the current environment is Windows based.

windows_os() : bool
Return values
bool

with()

Return the given value, optionally passed through the given callback.

with(TValue $value[, callable(TValue): TReturn|null $callback = null ]) : mixed
Parameters
$value : TValue
$callback : callable(TValue): TReturn|null = null
Tags
template
template

text()

Prompt the user for text input.

text(string $label[, string $placeholder = '' ][, string $default = '' ][, bool|string $required = false ][, mixed $validate = null ][, string $hint = '' ][, Closure|null $transform = null ]) : string
Parameters
$label : string
$placeholder : string = ''
$default : string = ''
$required : bool|string = false
$validate : mixed = null
$hint : string = ''
$transform : Closure|null = null
Return values
string

textarea()

Prompt the user for multiline text input.

textarea(string $label[, string $placeholder = '' ][, string $default = '' ][, bool|string $required = false ][, mixed $validate = null ][, string $hint = '' ][, int $rows = 5 ][, Closure|null $transform = null ]) : string
Parameters
$label : string
$placeholder : string = ''
$default : string = ''
$required : bool|string = false
$validate : mixed = null
$hint : string = ''
$rows : int = 5
$transform : Closure|null = null
Return values
string

password()

Prompt the user for input, hiding the value.

password(string $label[, string $placeholder = '' ][, bool|string $required = false ][, mixed $validate = null ][, string $hint = '' ][, Closure|null $transform = null ]) : string
Parameters
$label : string
$placeholder : string = ''
$required : bool|string = false
$validate : mixed = null
$hint : string = ''
$transform : Closure|null = null
Return values
string

select()

Prompt the user to select an option.

select(string $label, array<int|string, string>|Collection<int|string, string> $options[, int|string|null $default = null ][, int $scroll = 5 ][, mixed $validate = null ][, string $hint = '' ][, true|string $required = true ][, Closure|null $transform = null ]) : int|string
Parameters
$label : string
$options : array<int|string, string>|Collection<int|string, string>
$default : int|string|null = null
$scroll : int = 5
$validate : mixed = null
$hint : string = ''
$required : true|string = true
$transform : Closure|null = null
Return values
int|string

multiselect()

Prompt the user to select multiple options.

multiselect(string $label, array<int|string, string>|Collection<int|string, string> $options[, array<string|int, int|string>|Collection<int, int|string> $default = [] ][, int $scroll = 5 ][, bool|string $required = false ][, mixed $validate = null ][, string $hint = 'Use the space bar to select options.' ][, Closure|null $transform = null ]) : array<string|int, int|string>
Parameters
$label : string
$options : array<int|string, string>|Collection<int|string, string>
$default : array<string|int, int|string>|Collection<int, int|string> = []
$scroll : int = 5
$required : bool|string = false
$validate : mixed = null
$hint : string = 'Use the space bar to select options.'
$transform : Closure|null = null
Return values
array<string|int, int|string>

confirm()

Prompt the user to confirm an action.

confirm(string $label[, bool $default = true ][, string $yes = 'Yes' ][, string $no = 'No' ][, bool|string $required = false ][, mixed $validate = null ][, string $hint = '' ][, Closure|null $transform = null ]) : bool
Parameters
$label : string
$default : bool = true
$yes : string = 'Yes'
$no : string = 'No'
$required : bool|string = false
$validate : mixed = null
$hint : string = ''
$transform : Closure|null = null
Return values
bool

pause()

Prompt the user to continue or cancel after pausing.

pause([string $message = 'Press enter to continue...' ]) : bool
Parameters
$message : string = 'Press enter to continue...'
Return values
bool

suggest()

Prompt the user for text input with auto-completion.

suggest(string $label, array<string|int, string>|Collection<int, string>|callable(string): array<string|int, string> $options[, string $placeholder = '' ][, string $default = '' ][, int $scroll = 5 ][, bool|string $required = false ][, mixed $validate = null ][, string $hint = '' ][, Closure|null $transform = null ]) : string
Parameters
$label : string
$options : array<string|int, string>|Collection<int, string>|callable(string): array<string|int, string>
$placeholder : string = ''
$default : string = ''
$scroll : int = 5
$required : bool|string = false
$validate : mixed = null
$hint : string = ''
$transform : Closure|null = null
Return values
string

search()

Allow the user to search for an option.

search(string $label, callable(string): array<int|string, string> $options[, string $placeholder = '' ][, int $scroll = 5 ][, mixed $validate = null ][, string $hint = '' ][, true|string $required = true ][, Closure|null $transform = null ]) : int|string
Parameters
$label : string
$options : callable(string): array<int|string, string>
$placeholder : string = ''
$scroll : int = 5
$validate : mixed = null
$hint : string = ''
$required : true|string = true
$transform : Closure|null = null
Return values
int|string

multisearch()

Allow the user to search for multiple option.

multisearch(string $label, callable(string): array<int|string, string> $options[, string $placeholder = '' ][, int $scroll = 5 ][, bool|string $required = false ][, mixed $validate = null ][, string $hint = 'Use the space bar to select options.' ][, Closure|null $transform = null ]) : array<string|int, int|string>
Parameters
$label : string
$options : callable(string): array<int|string, string>
$placeholder : string = ''
$scroll : int = 5
$required : bool|string = false
$validate : mixed = null
$hint : string = 'Use the space bar to select options.'
$transform : Closure|null = null
Return values
array<string|int, int|string>

spin()

Render a spinner while the given callback is executing.

spin(callable(): TReturn $callback[, string $message = '' ]) : TReturn
Parameters
$callback : callable(): TReturn
$message : string = ''
Tags
template
Return values
TReturn

note()

Display a note.

note(string $message[, string|null $type = null ]) : void
Parameters
$message : string
$type : string|null = null

error()

Display an error.

error(string $message) : void
Parameters
$message : string

warning()

Display a warning.

warning(string $message) : void
Parameters
$message : string

alert()

Display an alert.

alert(string $message) : void
Parameters
$message : string

info()

Display an informational message.

info(string $message) : void
Parameters
$message : string

intro()

Display an introduction.

intro(string $message) : void
Parameters
$message : string

outro()

Display a closing message.

outro(string $message) : void
Parameters
$message : string

table()

Display a table.

table([array<int, string|array<int, string>>|Collection<int, string|array<int, string>> $headers = [] ][, array<int, array<int, string>>|Collection<int, array<int, string>> $rows = null ]) : void
Parameters
$headers : array<int, string|array<int, string>>|Collection<int, string|array<int, string>> = []
$rows : array<int, array<int, string>>|Collection<int, array<int, string>> = null

progress()

Display a progress bar.

progress(string $label, TSteps $steps[, callable(mixed, Progress<string|int, TSteps>): TReturn|null $callback = null ][, string $hint = '' ]) : mixed
Parameters
$label : string
$steps : TSteps
$callback : callable(mixed, Progress<string|int, TSteps>): TReturn|null = null
$hint : string = ''
Tags
template
template

mock()

mock(mixed ...$args) : LegacyMockInterface|MockInterface|TMock
Parameters
$args : mixed
Tags
template
Return values
LegacyMockInterface|MockInterface|TMock

spy()

spy(mixed ...$args) : LegacyMockInterface|MockInterface|TSpy
Parameters
$args : mixed
Tags
template
Return values
LegacyMockInterface|MockInterface|TSpy

namedMock()

namedMock(array<string|int, TNamedMock>|TNamedMock|array<string|int, TNamedMock>> ...$args) : LegacyMockInterface|MockInterface|TNamedMock
Parameters
$args : array<string|int, TNamedMock>|TNamedMock|array<string|int, TNamedMock>>
Tags
template
Return values
LegacyMockInterface|MockInterface|TNamedMock

runSuite()

runSuite(mixed $file) : mixed
Parameters
$file : mixed

runCase()

runCase(mixed $given, mixed $expression, mixed $name) : mixed
Parameters
$given : mixed
$expression : mixed
$name : mixed

search()

search(mixed $expression, mixed $data) : mixed
Parameters
$expression : mixed
$data : mixed

deep_copy()

Deep copies the given value.

deep_copy(mixed $value[, bool $useCloneMethod = false ]) : mixed
Parameters
$value : mixed
$useCloneMethod : bool = false

getMaxHistoryMonthsByAmount()

getMaxHistoryMonthsByAmount(mixed $amount) : int
Parameters
$amount : mixed
Return values
int

getHtmlAttribute()

getHtmlAttribute(mixed $rawValue) : string
Parameters
$rawValue : mixed
Return values
string

getOpenCollectiveSponsors()

getOpenCollectiveSponsors() : string
Return values
string

style()

Creates a new style.

style(string $name[, Warning: Array to string conversion in C:\phpdoc-temp\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 64 callable(Styles $renderable, Array ...$arguments): Styles|null $callback = null ]) : Style
Parameters
$name : string
$callback : Warning: Array to string conversion in C:\phpdoc-temp\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 64 callable(Styles $renderable, Array ...$arguments): Styles|null = null
Return values
Style

render()

Render HTML to a string.

render(string $html[, int $options = OutputInterface::OUTPUT_NORMAL ]) : void
Parameters
$html : string
$options : int = OutputInterface::OUTPUT_NORMAL

terminal()

Returns a Terminal instance.

terminal() : Terminal
Return values
Terminal

ask()

Renders a prompt to the user.

ask(string $question[, iterable<string|int, string>|null $autocomplete = null ]) : mixed
Parameters
$question : string
$autocomplete : iterable<string|int, string>|null = null

assertArrayHasKey()

Asserts that an array has a specified key.

assertArrayHasKey(mixed $key, array<string|int, mixed>|ArrayAccess $array[, string $message = '' ]) : void
Parameters
$key : mixed
$array : array<string|int, mixed>|ArrayAccess
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertArrayHasKey

assertArrayNotHasKey()

Asserts that an array does not have a specified key.

assertArrayNotHasKey(mixed $key, array<string|int, mixed>|ArrayAccess $array[, string $message = '' ]) : void
Parameters
$key : mixed
$array : array<string|int, mixed>|ArrayAccess
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertArrayNotHasKey

assertIsList()

assertIsList(mixed $array[, string $message = '' ]) : void
Parameters
$array : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsList

assertContains()

Asserts that a haystack contains a needle.

assertContains(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$needle : mixed
$haystack : iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertContains

assertContainsEquals()

assertContainsEquals(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$needle : mixed
$haystack : iterable<string|int, mixed>
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertContainsEquals

assertNotContains()

Asserts that a haystack does not contain a needle.

assertNotContains(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$needle : mixed
$haystack : iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotContains

assertNotContainsEquals()

assertNotContainsEquals(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$needle : mixed
$haystack : iterable<string|int, mixed>
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotContainsEquals

assertContainsOnly()

Asserts that a haystack contains only values of a given type.

assertContainsOnly(string $type, iterable<string|int, mixed> $haystack[, bool|null $isNativeType = null ][, string $message = '' ]) : void
Parameters
$type : string
$haystack : iterable<string|int, mixed>
$isNativeType : bool|null = null
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertContainsOnly

assertContainsOnlyInstancesOf()

Asserts that a haystack contains only instances of a given class name.

assertContainsOnlyInstancesOf(string $className, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$className : string
$haystack : iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertContainsOnlyInstancesOf

assertNotContainsOnly()

Asserts that a haystack does not contain only values of a given type.

assertNotContainsOnly(string $type, iterable<string|int, mixed> $haystack[, bool|null $isNativeType = null ][, string $message = '' ]) : void
Parameters
$type : string
$haystack : iterable<string|int, mixed>
$isNativeType : bool|null = null
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotContainsOnly

assertCount()

Asserts the number of elements of an array, Countable or Traversable.

assertCount(int $expectedCount, Countable|iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$expectedCount : int
$haystack : Countable|iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertCount

assertNotCount()

Asserts the number of elements of an array, Countable or Traversable.

assertNotCount(int $expectedCount, Countable|iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$expectedCount : int
$haystack : Countable|iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotCount

assertEquals()

Asserts that two variables are equal.

assertEquals(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertEquals

assertEqualsCanonicalizing()

Asserts that two variables are equal (canonicalizing).

assertEqualsCanonicalizing(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertEqualsCanonicalizing

assertEqualsIgnoringCase()

Asserts that two variables are equal (ignoring case).

assertEqualsIgnoringCase(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertEqualsIgnoringCase

assertEqualsWithDelta()

Asserts that two variables are equal (with delta).

assertEqualsWithDelta(mixed $expected, mixed $actual, float $delta[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$delta : float
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertEqualsWithDelta

assertNotEquals()

Asserts that two variables are not equal.

assertNotEquals(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotEquals

assertNotEqualsCanonicalizing()

Asserts that two variables are not equal (canonicalizing).

assertNotEqualsCanonicalizing(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotEqualsCanonicalizing

assertNotEqualsIgnoringCase()

Asserts that two variables are not equal (ignoring case).

assertNotEqualsIgnoringCase(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotEqualsIgnoringCase

assertNotEqualsWithDelta()

Asserts that two variables are not equal (with delta).

assertNotEqualsWithDelta(mixed $expected, mixed $actual, float $delta[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$delta : float
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotEqualsWithDelta

assertObjectEquals()

assertObjectEquals(object $expected, object $actual[, string $method = 'equals' ][, string $message = '' ]) : void
Parameters
$expected : object
$actual : object
$method : string = 'equals'
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertObjectEquals

assertEmpty()

Asserts that a variable is empty.

assertEmpty(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
psalm-assert

empty $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertEmpty

assertNotEmpty()

Asserts that a variable is not empty.

assertNotEmpty(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
psalm-assert

!empty $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotEmpty

assertGreaterThan()

Asserts that a value is greater than another value.

assertGreaterThan(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertGreaterThan

assertGreaterThanOrEqual()

Asserts that a value is greater than or equal to another value.

assertGreaterThanOrEqual(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertGreaterThanOrEqual

assertLessThan()

Asserts that a value is smaller than another value.

assertLessThan(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertLessThan

assertLessThanOrEqual()

Asserts that a value is smaller than or equal to another value.

assertLessThanOrEqual(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertLessThanOrEqual

assertFileEquals()

Asserts that the contents of one file is equal to the contents of another file.

assertFileEquals(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileEquals

assertFileEqualsCanonicalizing()

Asserts that the contents of one file is equal to the contents of another file (canonicalizing).

assertFileEqualsCanonicalizing(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileEqualsCanonicalizing

assertFileEqualsIgnoringCase()

Asserts that the contents of one file is equal to the contents of another file (ignoring case).

assertFileEqualsIgnoringCase(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileEqualsIgnoringCase

assertFileNotEquals()

Asserts that the contents of one file is not equal to the contents of another file.

assertFileNotEquals(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileNotEquals

assertFileNotEqualsCanonicalizing()

Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).

assertFileNotEqualsCanonicalizing(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileNotEqualsCanonicalizing

assertFileNotEqualsIgnoringCase()

Asserts that the contents of one file is not equal to the contents of another file (ignoring case).

assertFileNotEqualsIgnoringCase(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileNotEqualsIgnoringCase

assertStringEqualsFile()

Asserts that the contents of a string is equal to the contents of a file.

assertStringEqualsFile(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEqualsFile

assertStringEqualsFileCanonicalizing()

Asserts that the contents of a string is equal to the contents of a file (canonicalizing).

assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEqualsFileCanonicalizing

assertStringEqualsFileIgnoringCase()

Asserts that the contents of a string is equal to the contents of a file (ignoring case).

assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEqualsFileIgnoringCase

assertStringNotEqualsFile()

Asserts that the contents of a string is not equal to the contents of a file.

assertStringNotEqualsFile(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotEqualsFile

assertStringNotEqualsFileCanonicalizing()

Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).

assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotEqualsFileCanonicalizing

assertStringNotEqualsFileIgnoringCase()

Asserts that the contents of a string is not equal to the contents of a file (ignoring case).

assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotEqualsFileIgnoringCase

assertIsReadable()

Asserts that a file/dir is readable.

assertIsReadable(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsReadable

assertIsNotReadable()

Asserts that a file/dir exists and is not readable.

assertIsNotReadable(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotReadable

assertIsWritable()

Asserts that a file/dir exists and is writable.

assertIsWritable(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsWritable

assertIsNotWritable()

Asserts that a file/dir exists and is not writable.

assertIsNotWritable(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotWritable

assertDirectoryExists()

Asserts that a directory exists.

assertDirectoryExists(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryExists

assertDirectoryDoesNotExist()

Asserts that a directory does not exist.

assertDirectoryDoesNotExist(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryDoesNotExist

assertDirectoryIsReadable()

Asserts that a directory exists and is readable.

assertDirectoryIsReadable(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryIsReadable

assertDirectoryIsNotReadable()

Asserts that a directory exists and is not readable.

assertDirectoryIsNotReadable(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryIsNotReadable

assertDirectoryIsWritable()

Asserts that a directory exists and is writable.

assertDirectoryIsWritable(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryIsWritable

assertDirectoryIsNotWritable()

Asserts that a directory exists and is not writable.

assertDirectoryIsNotWritable(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryIsNotWritable

assertFileExists()

Asserts that a file exists.

assertFileExists(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileExists

assertFileDoesNotExist()

Asserts that a file does not exist.

assertFileDoesNotExist(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileDoesNotExist

assertFileIsReadable()

Asserts that a file exists and is readable.

assertFileIsReadable(string $file[, string $message = '' ]) : void
Parameters
$file : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileIsReadable

assertFileIsNotReadable()

Asserts that a file exists and is not readable.

assertFileIsNotReadable(string $file[, string $message = '' ]) : void
Parameters
$file : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileIsNotReadable

assertFileIsWritable()

Asserts that a file exists and is writable.

assertFileIsWritable(string $file[, string $message = '' ]) : void
Parameters
$file : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileIsWritable

assertFileIsNotWritable()

Asserts that a file exists and is not writable.

assertFileIsNotWritable(string $file[, string $message = '' ]) : void
Parameters
$file : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileIsNotWritable

assertTrue()

Asserts that a condition is true.

assertTrue(mixed $condition[, string $message = '' ]) : void
Parameters
$condition : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

true $condition

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertTrue

assertNotTrue()

Asserts that a condition is not true.

assertNotTrue(mixed $condition[, string $message = '' ]) : void
Parameters
$condition : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

!true $condition

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotTrue

assertFalse()

Asserts that a condition is false.

assertFalse(mixed $condition[, string $message = '' ]) : void
Parameters
$condition : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

false $condition

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFalse

assertNotFalse()

Asserts that a condition is not false.

assertNotFalse(mixed $condition[, string $message = '' ]) : void
Parameters
$condition : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

!false $condition

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotFalse

assertNull()

Asserts that a variable is null.

assertNull(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

null $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNull

assertNotNull()

Asserts that a variable is not null.

assertNotNull(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

!null $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotNull

assertFinite()

Asserts that a variable is finite.

assertFinite(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFinite

assertInfinite()

Asserts that a variable is infinite.

assertInfinite(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertInfinite

assertNan()

Asserts that a variable is nan.

assertNan(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNan

assertObjectHasProperty()

Asserts that an object has a specified property.

assertObjectHasProperty(string $propertyName, object $object[, string $message = '' ]) : void
Parameters
$propertyName : string
$object : object
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertObjectHasProperty

assertObjectNotHasProperty()

Asserts that an object does not have a specified property.

assertObjectNotHasProperty(string $propertyName, object $object[, string $message = '' ]) : void
Parameters
$propertyName : string
$object : object
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertObjectNotHasProperty

assertSame()

Asserts that two variables have the same type and value.

assertSame(mixed $expected, mixed $actual[, string $message = '' ]) : void

Used on objects, it asserts that two variables reference the same object.

Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-template

ExpectedType

psalm-param

ExpectedType $expected

psalm-assert

=ExpectedType $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertSame

assertNotSame()

Asserts that two variables do not have the same type and value.

assertNotSame(mixed $expected, mixed $actual[, string $message = '' ]) : void

Used on objects, it asserts that two variables do not reference the same object.

Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotSame

assertInstanceOf()

Asserts that a variable is of a given type.

assertInstanceOf(string $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
UnknownClassOrInterfaceException
psalm-template

ExpectedType of object

psalm-param

class-string<ExpectedType> $expected

psalm-assert

=ExpectedType $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertInstanceOf

assertNotInstanceOf()

Asserts that a variable is not of a given type.

assertNotInstanceOf(string $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-template

ExpectedType of object

psalm-param

class-string<ExpectedType> $expected

psalm-assert

!ExpectedType $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotInstanceOf

assertIsArray()

Asserts that a variable is of type array.

assertIsArray(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

array $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsArray

assertIsBool()

Asserts that a variable is of type bool.

assertIsBool(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

bool $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsBool

assertIsFloat()

Asserts that a variable is of type float.

assertIsFloat(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

float $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsFloat

assertIsInt()

Asserts that a variable is of type int.

assertIsInt(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

int $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsInt

assertIsNumeric()

Asserts that a variable is of type numeric.

assertIsNumeric(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

numeric $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNumeric

assertIsObject()

Asserts that a variable is of type object.

assertIsObject(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

object $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsObject

assertIsResource()

Asserts that a variable is of type resource.

assertIsResource(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

resource $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsResource

assertIsClosedResource()

Asserts that a variable is of type resource and is closed.

assertIsClosedResource(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

resource $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsClosedResource

assertIsString()

Asserts that a variable is of type string.

assertIsString(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

string $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsString

assertIsScalar()

Asserts that a variable is of type scalar.

assertIsScalar(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

scalar $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsScalar

assertIsCallable()

Asserts that a variable is of type callable.

assertIsCallable(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

callable $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsCallable

assertIsIterable()

Asserts that a variable is of type iterable.

assertIsIterable(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

iterable $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsIterable

assertIsNotArray()

Asserts that a variable is not of type array.

assertIsNotArray(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!array $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotArray

assertIsNotBool()

Asserts that a variable is not of type bool.

assertIsNotBool(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!bool $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotBool

assertIsNotFloat()

Asserts that a variable is not of type float.

assertIsNotFloat(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!float $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotFloat

assertIsNotInt()

Asserts that a variable is not of type int.

assertIsNotInt(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!int $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotInt

assertIsNotNumeric()

Asserts that a variable is not of type numeric.

assertIsNotNumeric(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!numeric $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotNumeric

assertIsNotObject()

Asserts that a variable is not of type object.

assertIsNotObject(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!object $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotObject

assertIsNotResource()

Asserts that a variable is not of type resource.

assertIsNotResource(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!resource $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotResource

assertIsNotClosedResource()

Asserts that a variable is not of type resource.

assertIsNotClosedResource(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!resource $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotClosedResource

assertIsNotString()

Asserts that a variable is not of type string.

assertIsNotString(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!string $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotString

assertIsNotScalar()

Asserts that a variable is not of type scalar.

assertIsNotScalar(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!scalar $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotScalar

assertIsNotCallable()

Asserts that a variable is not of type callable.

assertIsNotCallable(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!callable $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotCallable

assertIsNotIterable()

Asserts that a variable is not of type iterable.

assertIsNotIterable(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!iterable $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotIterable

assertMatchesRegularExpression()

Asserts that a string matches a given regular expression.

assertMatchesRegularExpression(string $pattern, string $string[, string $message = '' ]) : void
Parameters
$pattern : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertMatchesRegularExpression

assertDoesNotMatchRegularExpression()

Asserts that a string does not match a given regular expression.

assertDoesNotMatchRegularExpression(string $pattern, string $string[, string $message = '' ]) : void
Parameters
$pattern : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDoesNotMatchRegularExpression

assertSameSize()

Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same.

assertSameSize(Countable|iterable<string|int, mixed> $expected, Countable|iterable<string|int, mixed> $actual[, string $message = '' ]) : void
Parameters
$expected : Countable|iterable<string|int, mixed>
$actual : Countable|iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertSameSize

assertNotSameSize()

Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same.

assertNotSameSize(Countable|iterable<string|int, mixed> $expected, Countable|iterable<string|int, mixed> $actual[, string $message = '' ]) : void
Parameters
$expected : Countable|iterable<string|int, mixed>
$actual : Countable|iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotSameSize

assertStringContainsStringIgnoringLineEndings()

assertStringContainsStringIgnoringLineEndings(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
$needle : string
$haystack : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringContainsStringIgnoringLineEndings

assertStringEqualsStringIgnoringLineEndings()

Asserts that two strings are equal except for line endings.

assertStringEqualsStringIgnoringLineEndings(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEqualsStringIgnoringLineEndings

assertFileMatchesFormat()

Asserts that a string matches a given format string.

assertFileMatchesFormat(string $format, string $actualFile[, string $message = '' ]) : void
Parameters
$format : string
$actualFile : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileMatchesFormat

assertFileMatchesFormatFile()

Asserts that a string matches a given format string.

assertFileMatchesFormatFile(string $formatFile, string $actualFile[, string $message = '' ]) : void
Parameters
$formatFile : string
$actualFile : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileMatchesFormatFile

assertStringMatchesFormat()

Asserts that a string matches a given format string.

assertStringMatchesFormat(string $format, string $string[, string $message = '' ]) : void
Parameters
$format : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringMatchesFormat

assertStringNotMatchesFormat()

Asserts that a string does not match a given format string.

https://github.com/sebastianbergmann/phpunit/issues/5472

assertStringNotMatchesFormat(string $format, string $string[, string $message = '' ]) : void
Parameters
$format : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotMatchesFormat

assertStringMatchesFormatFile()

Asserts that a string matches a given format file.

assertStringMatchesFormatFile(string $formatFile, string $string[, string $message = '' ]) : void
Parameters
$formatFile : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringMatchesFormatFile

assertStringNotMatchesFormatFile()

Asserts that a string does not match a given format string.

https://github.com/sebastianbergmann/phpunit/issues/5472

assertStringNotMatchesFormatFile(string $formatFile, string $string[, string $message = '' ]) : void
Parameters
$formatFile : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotMatchesFormatFile

assertStringStartsWith()

Asserts that a string starts with a given prefix.

assertStringStartsWith(string $prefix, string $string[, string $message = '' ]) : void
Parameters
$prefix : string
$string : string
$message : string = ''
Tags
psalm-param

non-empty-string $prefix

throws
ExpectationFailedException
throws
InvalidArgumentException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringStartsWith

assertStringStartsNotWith()

Asserts that a string starts not with a given prefix.

assertStringStartsNotWith(string $prefix, string $string[, string $message = '' ]) : void
Parameters
$prefix : string
$string : string
$message : string = ''
Tags
psalm-param

non-empty-string $prefix

throws
ExpectationFailedException
throws
InvalidArgumentException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringStartsNotWith

assertStringContainsString()

assertStringContainsString(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
$needle : string
$haystack : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringContainsString

assertStringContainsStringIgnoringCase()

assertStringContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
$needle : string
$haystack : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringContainsStringIgnoringCase

assertStringNotContainsString()

assertStringNotContainsString(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
$needle : string
$haystack : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotContainsString

assertStringNotContainsStringIgnoringCase()

assertStringNotContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
$needle : string
$haystack : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotContainsStringIgnoringCase

assertStringEndsWith()

Asserts that a string ends with a given suffix.

assertStringEndsWith(string $suffix, string $string[, string $message = '' ]) : void
Parameters
$suffix : string
$string : string
$message : string = ''
Tags
psalm-param

non-empty-string $suffix

throws
ExpectationFailedException
throws
InvalidArgumentException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEndsWith

assertStringEndsNotWith()

Asserts that a string ends not with a given suffix.

assertStringEndsNotWith(string $suffix, string $string[, string $message = '' ]) : void
Parameters
$suffix : string
$string : string
$message : string = ''
Tags
psalm-param

non-empty-string $suffix

throws
ExpectationFailedException
throws
InvalidArgumentException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEndsNotWith

assertXmlFileEqualsXmlFile()

Asserts that two XML files are equal.

assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualFile : string
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
XmlException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlFileEqualsXmlFile

assertXmlFileNotEqualsXmlFile()

Asserts that two XML files are not equal.

assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualFile : string
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlFileNotEqualsXmlFile

assertXmlStringEqualsXmlFile()

Asserts that two XML documents are equal.

assertXmlStringEqualsXmlFile(string $expectedFile, string $actualXml[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualXml : string
$message : string = ''
Tags
throws
ExpectationFailedException
throws
XmlException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlStringEqualsXmlFile

assertXmlStringNotEqualsXmlFile()

Asserts that two XML documents are not equal.

assertXmlStringNotEqualsXmlFile(string $expectedFile, string $actualXml[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualXml : string
$message : string = ''
Tags
throws
ExpectationFailedException
throws
XmlException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlStringNotEqualsXmlFile

assertXmlStringEqualsXmlString()

Asserts that two XML documents are equal.

assertXmlStringEqualsXmlString(string $expectedXml, string $actualXml[, string $message = '' ]) : void
Parameters
$expectedXml : string
$actualXml : string
$message : string = ''
Tags
throws
ExpectationFailedException
throws
XmlException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlStringEqualsXmlString

assertXmlStringNotEqualsXmlString()

Asserts that two XML documents are not equal.

assertXmlStringNotEqualsXmlString(string $expectedXml, string $actualXml[, string $message = '' ]) : void
Parameters
$expectedXml : string
$actualXml : string
$message : string = ''
Tags
throws
ExpectationFailedException
throws
XmlException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlStringNotEqualsXmlString

assertThat()

Evaluates a PHPUnit\Framework\Constraint matcher object.

assertThat(mixed $value, Constraint $constraint[, string $message = '' ]) : void
Parameters
$value : mixed
$constraint : Constraint
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertThat

assertJson()

Asserts that a string is a valid JSON string.

assertJson(string $actual[, string $message = '' ]) : void
Parameters
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJson

assertJsonStringEqualsJsonString()

Asserts that two given JSON encoded objects or arrays are equal.

assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson[, string $message = '' ]) : void
Parameters
$expectedJson : string
$actualJson : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonStringEqualsJsonString

assertJsonStringNotEqualsJsonString()

Asserts that two given JSON encoded objects or arrays are not equal.

assertJsonStringNotEqualsJsonString(string $expectedJson, string $actualJson[, string $message = '' ]) : void
Parameters
$expectedJson : string
$actualJson : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonStringNotEqualsJsonString

assertJsonStringEqualsJsonFile()

Asserts that the generated JSON encoded object and the content of the given file are equal.

assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualJson : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonStringEqualsJsonFile

assertJsonStringNotEqualsJsonFile()

Asserts that the generated JSON encoded object and the content of the given file are not equal.

assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualJson : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonStringNotEqualsJsonFile

assertJsonFileEqualsJsonFile()

Asserts that two JSON files are equal.

assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualFile : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonFileEqualsJsonFile

assertJsonFileNotEqualsJsonFile()

Asserts that two JSON files are not equal.

assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualFile : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonFileNotEqualsJsonFile

objectEquals()

objectEquals(object $object[, string $method = 'equals' ]) : ObjectEquals
Parameters
$object : object
$method : string = 'equals'
Return values
ObjectEquals

callback()

callback(callable $callback) : Callback
Parameters
$callback : callable
Tags
psalm-template

CallbackInput of mixed

psalm-param

callable(CallbackInput $callback): bool $callback

psalm-return

Callback<CallbackInput>

Return values
Callback

any()

Returns a matcher that matches when the method is executed zero or more times.

any() : AnyInvokedCount
Return values
AnyInvokedCount

never()

Returns a matcher that matches when the method is never executed.

never() : InvokedCount
Return values
InvokedCount

atLeast()

Returns a matcher that matches when the method is executed at least N times.

atLeast(int $requiredInvocations) : InvokedAtLeastCount
Parameters
$requiredInvocations : int
Return values
InvokedAtLeastCount

atLeastOnce()

Returns a matcher that matches when the method is executed at least once.

atLeastOnce() : InvokedAtLeastOnce
Return values
InvokedAtLeastOnce

once()

Returns a matcher that matches when the method is executed exactly once.

once() : InvokedCount
Return values
InvokedCount

exactly()

Returns a matcher that matches when the method is executed exactly $count times.

exactly(int $count) : InvokedCount
Parameters
$count : int
Return values
InvokedCount

atMost()

Returns a matcher that matches when the method is executed at most N times.

atMost(int $allowedInvocations) : InvokedAtMostCount
Parameters
$allowedInvocations : int
Return values
InvokedAtMostCount

returnValue()

returnValue(mixed $value) : ReturnStub
Parameters
$value : mixed
Return values
ReturnStub

returnValueMap()

returnValueMap(array<string|int, mixed> $valueMap) : ReturnValueMap
Parameters
$valueMap : array<string|int, mixed>
Return values
ReturnValueMap

returnArgument()

returnArgument(int $argumentIndex) : ReturnArgument
Parameters
$argumentIndex : int
Return values
ReturnArgument

returnCallback()

returnCallback(callable $callback) : ReturnCallback
Parameters
$callback : callable
Return values
ReturnCallback

returnSelf()

Returns the current object.

returnSelf() : ReturnSelf

This method is useful when mocking a fluent interface.

Return values
ReturnSelf

throwException()

throwException(Throwable $exception) : Exception
Parameters
$exception : Throwable
Return values
Exception

onConsecutiveCalls()

onConsecutiveCalls() : ConsecutiveCalls
Return values
ConsecutiveCalls

sh()

Command to return the eval-able code to startup PsySH.

sh() : string

eval(\Psy\sh());

Return values
string

debug()

Invoke a Psy Shell from the current context.

debug([array<string|int, mixed> $vars = [] ][, object|string $bindTo = null ]) : array<string|int, mixed>

For example:

foreach ($items as $item) {
    \Psy\debug(get_defined_vars());
}

If you would like your shell interaction to affect the state of the current context, you can extract() the values returned from this call:

foreach ($items as $item) {
    extract(\Psy\debug(get_defined_vars()));
    var_dump($item); // will be whatever you set $item to in Psy Shell
}

Optionally, supply an object as the $bindTo parameter. This determines the value $this will have in the shell, and sets up class scope so that private and protected members are accessible:

class Foo {
    function bar() {
        \Psy\debug(get_defined_vars(), $this);
    }
}

For the static equivalent, pass a class name as the $bindTo parameter. This makes self work in the shell, and sets up static scope so that private and protected static members are accessible:

class Foo {
    static function bar() {
        \Psy\debug(get_defined_vars(), get_called_class());
    }
}
Parameters
$vars : array<string|int, mixed> = []

Scope variables from the calling context (default: [])

$bindTo : object|string = null

Bound object ($this) or class (self) value for the shell

Return values
array<string|int, mixed> —

Scope variables from the debugger session

info()

Get a bunch of debugging info about the current PsySH environment and configuration.

info([Configuration|null $config = null ]) : array<string|int, mixed>|null

If a Configuration param is passed, that configuration is stored and used for the current shell session, and no debugging info is returned.

Parameters
$config : Configuration|null = null
Return values
array<string|int, mixed>|null

bin()

`psysh` command line executable.

bin() : Closure
Return values
Closure

getallheaders()

Get all HTTP header key/values as an associative array for the current request.

getallheaders() : mixed
Return values
mixed —

The HTTP header key/value pairs.

v1()

Returns a version 1 (Gregorian time) UUID from a host ID, sequence number, and the current time

v1([Hexadecimal|int|string|null $node = null ][, int|null $clockSeq = null ]) : non-empty-string
Parameters
$node : Hexadecimal|int|string|null = null

A 48-bit number representing the hardware address; this number may be represented as an integer or a hexadecimal string

$clockSeq : int|null = null

A 14-bit number used to help avoid duplicates that could arise when the clock is set backwards in time or if the node ID changes

Return values
non-empty-string —

Version 1 UUID as a string

v2()

Returns a version 2 (DCE Security) UUID from a local domain, local identifier, host ID, clock sequence, and the current time

v2(int $localDomain[, Integer|null $localIdentifier = null ][, Hexadecimal|null $node = null ][, int|null $clockSeq = null ]) : non-empty-string
Parameters
$localDomain : int

The local domain to use when generating bytes, according to DCE Security

$localIdentifier : Integer|null = null

The local identifier for the given domain; this may be a UID or GID on POSIX systems, if the local domain is person or group, or it may be a site-defined identifier if the local domain is org

$node : Hexadecimal|null = null

A 48-bit number representing the hardware address

$clockSeq : int|null = null

A 14-bit number used to help avoid duplicates that could arise when the clock is set backwards in time or if the node ID changes

Return values
non-empty-string —

Version 2 UUID as a string

v3()

Returns a version 3 (name-based) UUID based on the MD5 hash of a namespace ID and a name

v3(string|UuidInterface $ns, string $name) : non-empty-string
Parameters
$ns : string|UuidInterface

The namespace (must be a valid UUID)

$name : string
Tags
psalm-pure

note: changing the internal factory is an edge case not covered by purity invariants, but under constant factory setups, this method operates in functionally pure manners

Return values
non-empty-string —

Version 3 UUID as a string

v4()

Returns a version 4 (random) UUID

v4() : non-empty-string
Return values
non-empty-string —

Version 4 UUID as a string

v5()

Returns a version 5 (name-based) UUID based on the SHA-1 hash of a namespace ID and a name

v5(string|UuidInterface $ns, string $name) : non-empty-string
Parameters
$ns : string|UuidInterface

The namespace (must be a valid UUID)

$name : string
Tags
psalm-pure

note: changing the internal factory is an edge case not covered by purity invariants, but under constant factory setups, this method operates in functionally pure manners

Return values
non-empty-string —

Version 5 UUID as a string

v6()

Returns a version 6 (reordered time) UUID from a host ID, sequence number, and the current time

v6([Hexadecimal|null $node = null ][, int|null $clockSeq = null ]) : non-empty-string
Parameters
$node : Hexadecimal|null = null

A 48-bit number representing the hardware address

$clockSeq : int|null = null

A 14-bit number used to help avoid duplicates that could arise when the clock is set backwards in time or if the node ID changes

Return values
non-empty-string —

Version 6 UUID as a string

v7()

Returns a version 7 (Unix Epoch time) UUID

v7([DateTimeInterface|null $dateTime = null ]) : non-empty-string
Parameters
$dateTime : DateTimeInterface|null = null

An optional date/time from which to create the version 7 UUID. If not provided, the UUID is generated using the current date/time.

Return values
non-empty-string —

Version 7 UUID as a string

v8()

Returns a version 8 (custom) UUID

v8(string $bytes) : non-empty-string

The bytes provided may contain any value according to your application's needs. Be aware, however, that other applications may not understand the semantics of the value.

Parameters
$bytes : string

A 16-byte octet string. This is an open blob of data that you may fill with 128 bits of information. Be aware, however, bits 48 through 51 will be replaced with the UUID version field, and bits 64 and 65 will be replaced with the UUID variant. You MUST NOT rely on these bits for your application needs.

Return values
non-empty-string —

Version 8 UUID as a string

array_merge_recursive_distinct()

array_merge_recursive_distinct(array<int|string, mixed> &$array1, array<int|string, mixed> &$array2) : array<int|string, mixed>
Parameters
$array1 : array<int|string, mixed>
$array2 : array<int|string, mixed>
Return values
array<int|string, mixed>

trigger_deprecation()

Triggers a silenced deprecation notice.

trigger_deprecation(string $package, string $version, string $message, mixed ...$args) : void
Parameters
$package : string

The name of the Composer package that is triggering the deprecation

$version : string

The version of the package that introduced the deprecation

$message : string

The message of the deprecation

$args : mixed

Values to insert in the message using printf() formatting

Tags
author

Nicolas Grekas p@tchwork.com

ctype_alnum()

ctype_alnum(mixed $text) : mixed
Parameters
$text : mixed

ctype_alpha()

ctype_alpha(mixed $text) : mixed
Parameters
$text : mixed

ctype_cntrl()

ctype_cntrl(mixed $text) : mixed
Parameters
$text : mixed

ctype_digit()

ctype_digit(mixed $text) : mixed
Parameters
$text : mixed

ctype_graph()

ctype_graph(mixed $text) : mixed
Parameters
$text : mixed

ctype_lower()

ctype_lower(mixed $text) : mixed
Parameters
$text : mixed

ctype_print()

ctype_print(mixed $text) : mixed
Parameters
$text : mixed

ctype_punct()

ctype_punct(mixed $text) : mixed
Parameters
$text : mixed

ctype_space()

ctype_space(mixed $text) : mixed
Parameters
$text : mixed

ctype_upper()

ctype_upper(mixed $text) : mixed
Parameters
$text : mixed

ctype_xdigit()

ctype_xdigit(mixed $text) : mixed
Parameters
$text : mixed

ctype_alnum()

ctype_alnum(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

ctype_alpha()

ctype_alpha(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

ctype_cntrl()

ctype_cntrl(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

ctype_digit()

ctype_digit(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

ctype_graph()

ctype_graph(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

ctype_lower()

ctype_lower(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

ctype_print()

ctype_print(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

ctype_punct()

ctype_punct(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

ctype_space()

ctype_space(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

ctype_upper()

ctype_upper(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

ctype_xdigit()

ctype_xdigit(mixed $text) : bool
Parameters
$text : mixed
Return values
bool

grapheme_extract()

grapheme_extract(mixed $haystack, mixed $size[, mixed $type = 0 ][, mixed $start = 0 ][, mixed &$next = 0 ]) : mixed
Parameters
$haystack : mixed
$size : mixed
$type : mixed = 0
$start : mixed = 0
$next : mixed = 0

grapheme_stripos()

grapheme_stripos(mixed $haystack, mixed $needle[, mixed $offset = 0 ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0

grapheme_stristr()

grapheme_stristr(mixed $haystack, mixed $needle[, mixed $beforeNeedle = false ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$beforeNeedle : mixed = false

grapheme_strlen()

grapheme_strlen(mixed $input) : mixed
Parameters
$input : mixed

grapheme_strpos()

grapheme_strpos(mixed $haystack, mixed $needle[, mixed $offset = 0 ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0

grapheme_strripos()

grapheme_strripos(mixed $haystack, mixed $needle[, mixed $offset = 0 ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0

grapheme_strrpos()

grapheme_strrpos(mixed $haystack, mixed $needle[, mixed $offset = 0 ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0

grapheme_strstr()

grapheme_strstr(mixed $haystack, mixed $needle[, mixed $beforeNeedle = false ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$beforeNeedle : mixed = false

grapheme_substr()

grapheme_substr(mixed $string, mixed $offset[, mixed $length = null ]) : mixed
Parameters
$string : mixed
$offset : mixed
$length : mixed = null

grapheme_extract()

grapheme_extract(string|null $haystack, int|null $size[, int|null $type = GRAPHEME_EXTR_COUNT ][, int|null $offset = 0 ][, mixed &$next = null ]) : string|false
Parameters
$haystack : string|null
$size : int|null
$type : int|null = GRAPHEME_EXTR_COUNT
$offset : int|null = 0
$next : mixed = null
Return values
string|false

grapheme_stripos()

grapheme_stripos(string|null $haystack, string|null $needle[, int|null $offset = 0 ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
Return values
int|false

grapheme_stristr()

grapheme_stristr(string|null $haystack, string|null $needle[, bool|null $beforeNeedle = false ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$beforeNeedle : bool|null = false
Return values
string|false

grapheme_strlen()

grapheme_strlen(string|null $string) : int|false|null
Parameters
$string : string|null
Return values
int|false|null

grapheme_strpos()

grapheme_strpos(string|null $haystack, string|null $needle[, int|null $offset = 0 ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
Return values
int|false

grapheme_strripos()

grapheme_strripos(string|null $haystack, string|null $needle[, int|null $offset = 0 ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
Return values
int|false

grapheme_strrpos()

grapheme_strrpos(string|null $haystack, string|null $needle[, int|null $offset = 0 ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
Return values
int|false

grapheme_strstr()

grapheme_strstr(string|null $haystack, string|null $needle[, bool|null $beforeNeedle = false ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$beforeNeedle : bool|null = false
Return values
string|false

grapheme_substr()

grapheme_substr(string|null $string, int|null $offset[, int|null $length = null ]) : string|false
Parameters
$string : string|null
$offset : int|null
$length : int|null = null
Return values
string|false

idn_to_ascii()

idn_to_ascii(mixed $domain[, mixed $flags = 0 ][, mixed $variant = INTL_IDNA_VARIANT_UTS46 ][, mixed &$idna_info = null ]) : mixed
Parameters
$domain : mixed
$flags : mixed = 0
$variant : mixed = INTL_IDNA_VARIANT_UTS46
$idna_info : mixed = null

idn_to_utf8()

idn_to_utf8(mixed $domain[, mixed $flags = 0 ][, mixed $variant = INTL_IDNA_VARIANT_UTS46 ][, mixed &$idna_info = null ]) : mixed
Parameters
$domain : mixed
$flags : mixed = 0
$variant : mixed = INTL_IDNA_VARIANT_UTS46
$idna_info : mixed = null

idn_to_ascii()

idn_to_ascii(string|null $domain[, int|null $flags = IDNA_DEFAULT ][, int|null $variant = INTL_IDNA_VARIANT_UTS46 ][, mixed &$idna_info = null ]) : string|false
Parameters
$domain : string|null
$flags : int|null = IDNA_DEFAULT
$variant : int|null = INTL_IDNA_VARIANT_UTS46
$idna_info : mixed = null
Return values
string|false

idn_to_utf8()

idn_to_utf8(string|null $domain[, int|null $flags = IDNA_DEFAULT ][, int|null $variant = INTL_IDNA_VARIANT_UTS46 ][, mixed &$idna_info = null ]) : string|false
Parameters
$domain : string|null
$flags : int|null = IDNA_DEFAULT
$variant : int|null = INTL_IDNA_VARIANT_UTS46
$idna_info : mixed = null
Return values
string|false

normalizer_is_normalized()

normalizer_is_normalized(mixed $string[, mixed $form = pNormalizer::FORM_C ]) : mixed
Parameters
$string : mixed
$form : mixed = pNormalizer::FORM_C

normalizer_normalize()

normalizer_normalize(mixed $string[, mixed $form = pNormalizer::FORM_C ]) : mixed
Parameters
$string : mixed
$form : mixed = pNormalizer::FORM_C

normalizer_is_normalized()

normalizer_is_normalized(string|null $string[, int|null $form = pNormalizer::FORM_C ]) : bool
Parameters
$string : string|null
$form : int|null = pNormalizer::FORM_C
Return values
bool

normalizer_normalize()

normalizer_normalize(string|null $string[, int|null $form = pNormalizer::FORM_C ]) : string|false
Parameters
$string : string|null
$form : int|null = pNormalizer::FORM_C
Return values
string|false

mb_convert_encoding()

mb_convert_encoding(mixed $string, mixed $to_encoding[, mixed $from_encoding = null ]) : mixed
Parameters
$string : mixed
$to_encoding : mixed
$from_encoding : mixed = null

mb_decode_mimeheader()

mb_decode_mimeheader(mixed $string) : mixed
Parameters
$string : mixed

mb_encode_mimeheader()

mb_encode_mimeheader(mixed $string[, mixed $charset = null ][, mixed $transfer_encoding = null ][, mixed $newline = " " ][, mixed $indent = 0 ]) : mixed
Parameters
$string : mixed
$charset : mixed = null
$transfer_encoding : mixed = null
$newline : mixed = " "
$indent : mixed = 0

mb_decode_numericentity()

mb_decode_numericentity(mixed $string, mixed $map[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$map : mixed
$encoding : mixed = null

mb_encode_numericentity()

mb_encode_numericentity(mixed $string, mixed $map[, mixed $encoding = null ][, mixed $hex = false ]) : mixed
Parameters
$string : mixed
$map : mixed
$encoding : mixed = null
$hex : mixed = false

mb_convert_case()

mb_convert_case(mixed $string, mixed $mode[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$mode : mixed
$encoding : mixed = null

mb_internal_encoding()

mb_internal_encoding([mixed $encoding = null ]) : mixed
Parameters
$encoding : mixed = null

mb_language()

mb_language([mixed $language = null ]) : mixed
Parameters
$language : mixed = null

mb_list_encodings()

mb_list_encodings() : mixed

mb_encoding_aliases()

mb_encoding_aliases(mixed $encoding) : mixed
Parameters
$encoding : mixed

mb_check_encoding()

mb_check_encoding([mixed $value = null ][, mixed $encoding = null ]) : mixed
Parameters
$value : mixed = null
$encoding : mixed = null

mb_detect_encoding()

mb_detect_encoding(mixed $string[, mixed $encodings = null ][, mixed $strict = false ]) : mixed
Parameters
$string : mixed
$encodings : mixed = null
$strict : mixed = false

mb_detect_order()

mb_detect_order([mixed $encoding = null ]) : mixed
Parameters
$encoding : mixed = null

mb_parse_str()

mb_parse_str(mixed $string[, mixed &$result = [] ]) : mixed
Parameters
$string : mixed
$result : mixed = []

mb_strlen()

mb_strlen(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_strpos()

mb_strpos(mixed $haystack, mixed $needle[, mixed $offset = 0 ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0
$encoding : mixed = null

mb_strtolower()

mb_strtolower(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_strtoupper()

mb_strtoupper(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_substitute_character()

mb_substitute_character([mixed $substitute_character = null ]) : mixed
Parameters
$substitute_character : mixed = null

mb_substr()

mb_substr(mixed $string, mixed $start[, mixed $length = 2147483647 ][, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$start : mixed
$length : mixed = 2147483647
$encoding : mixed = null

mb_stripos()

mb_stripos(mixed $haystack, mixed $needle[, mixed $offset = 0 ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0
$encoding : mixed = null

mb_stristr()

mb_stristr(mixed $haystack, mixed $needle[, mixed $before_needle = false ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$before_needle : mixed = false
$encoding : mixed = null

mb_strrchr()

mb_strrchr(mixed $haystack, mixed $needle[, mixed $before_needle = false ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$before_needle : mixed = false
$encoding : mixed = null

mb_strrichr()

mb_strrichr(mixed $haystack, mixed $needle[, mixed $before_needle = false ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$before_needle : mixed = false
$encoding : mixed = null

mb_strripos()

mb_strripos(mixed $haystack, mixed $needle[, mixed $offset = 0 ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0
$encoding : mixed = null

mb_strrpos()

mb_strrpos(mixed $haystack, mixed $needle[, mixed $offset = 0 ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0
$encoding : mixed = null

mb_strstr()

mb_strstr(mixed $haystack, mixed $needle[, mixed $before_needle = false ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$before_needle : mixed = false
$encoding : mixed = null

mb_get_info()

mb_get_info([mixed $type = 'all' ]) : mixed
Parameters
$type : mixed = 'all'

mb_http_output()

mb_http_output([mixed $encoding = null ]) : mixed
Parameters
$encoding : mixed = null

mb_strwidth()

mb_strwidth(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_substr_count()

mb_substr_count(mixed $haystack, mixed $needle[, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$encoding : mixed = null

mb_output_handler()

mb_output_handler(mixed $string, mixed $status) : mixed
Parameters
$string : mixed
$status : mixed

mb_http_input()

mb_http_input([mixed $type = null ]) : mixed
Parameters
$type : mixed = null

mb_convert_variables()

mb_convert_variables(mixed $to_encoding, mixed $from_encoding, mixed ...&$vars) : mixed
Parameters
$to_encoding : mixed
$from_encoding : mixed
$vars : mixed

mb_ord()

mb_ord(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_chr()

mb_chr(mixed $codepoint[, mixed $encoding = null ]) : mixed
Parameters
$codepoint : mixed
$encoding : mixed = null

mb_scrub()

mb_scrub(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_str_split()

mb_str_split(mixed $string[, mixed $length = 1 ][, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$length : mixed = 1
$encoding : mixed = null

mb_str_pad()

mb_str_pad(string $string, int $length[, string $pad_string = ' ' ][, int $pad_type = STR_PAD_RIGHT ][, string|null $encoding = null ]) : string
Parameters
$string : string
$length : int
$pad_string : string = ' '
$pad_type : int = STR_PAD_RIGHT
$encoding : string|null = null
Return values
string

mb_ucfirst()

mb_ucfirst(string $string[, string|null $encoding = null ]) : string
Parameters
$string : string
$encoding : string|null = null
Return values
string

mb_lcfirst()

mb_lcfirst(string $string[, string|null $encoding = null ]) : string
Parameters
$string : string
$encoding : string|null = null
Return values
string

mb_trim()

mb_trim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

mb_ltrim()

mb_ltrim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

mb_rtrim()

mb_rtrim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

mb_convert_encoding()

mb_convert_encoding(array<string|int, mixed>|string|null $string, string|null $to_encoding[, array<string|int, mixed>|string|null $from_encoding = null ]) : array<string|int, mixed>|string|false
Parameters
$string : array<string|int, mixed>|string|null
$to_encoding : string|null
$from_encoding : array<string|int, mixed>|string|null = null
Return values
array<string|int, mixed>|string|false

mb_decode_mimeheader()

mb_decode_mimeheader(string|null $string) : string
Parameters
$string : string|null
Return values
string

mb_encode_mimeheader()

mb_encode_mimeheader(string|null $string[, string|null $charset = null ][, string|null $transfer_encoding = null ][, string|null $newline = " " ][, int|null $indent = 0 ]) : string
Parameters
$string : string|null
$charset : string|null = null
$transfer_encoding : string|null = null
$newline : string|null = " "
$indent : int|null = 0
Return values
string

mb_decode_numericentity()

mb_decode_numericentity(string|null $string, array<string|int, mixed> $map[, string|null $encoding = null ]) : string
Parameters
$string : string|null
$map : array<string|int, mixed>
$encoding : string|null = null
Return values
string

mb_encode_numericentity()

mb_encode_numericentity(string|null $string, array<string|int, mixed> $map[, string|null $encoding = null ][, bool|null $hex = false ]) : string
Parameters
$string : string|null
$map : array<string|int, mixed>
$encoding : string|null = null
$hex : bool|null = false
Return values
string

mb_convert_case()

mb_convert_case(string|null $string, int|null $mode[, string|null $encoding = null ]) : string
Parameters
$string : string|null
$mode : int|null
$encoding : string|null = null
Return values
string

mb_internal_encoding()

mb_internal_encoding([string|null $encoding = null ]) : string|bool
Parameters
$encoding : string|null = null
Return values
string|bool

mb_language()

mb_language([string|null $language = null ]) : string|bool
Parameters
$language : string|null = null
Return values
string|bool

mb_list_encodings()

mb_list_encodings() : array<string|int, mixed>
Return values
array<string|int, mixed>

mb_encoding_aliases()

mb_encoding_aliases(string|null $encoding) : array<string|int, mixed>
Parameters
$encoding : string|null
Return values
array<string|int, mixed>

mb_check_encoding()

mb_check_encoding([array<string|int, mixed>|string|null $value = null ][, string|null $encoding = null ]) : bool
Parameters
$value : array<string|int, mixed>|string|null = null
$encoding : string|null = null
Return values
bool

mb_detect_encoding()

mb_detect_encoding(string|null $string[, array<string|int, mixed>|string|null $encodings = null ][, bool|null $strict = false ]) : string|false
Parameters
$string : string|null
$encodings : array<string|int, mixed>|string|null = null
$strict : bool|null = false
Return values
string|false

mb_detect_order()

mb_detect_order([array<string|int, mixed>|string|null $encoding = null ]) : array<string|int, mixed>|bool
Parameters
$encoding : array<string|int, mixed>|string|null = null
Return values
array<string|int, mixed>|bool

mb_parse_str()

mb_parse_str(string|null $string[, mixed &$result = [] ]) : bool
Parameters
$string : string|null
$result : mixed = []
Return values
bool

mb_strlen()

mb_strlen(string|null $string[, string|null $encoding = null ]) : int
Parameters
$string : string|null
$encoding : string|null = null
Return values
int

mb_strpos()

mb_strpos(string|null $haystack, string|null $needle[, int|null $offset = 0 ][, string|null $encoding = null ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
$encoding : string|null = null
Return values
int|false

mb_strtolower()

mb_strtolower(string|null $string[, string|null $encoding = null ]) : string
Parameters
$string : string|null
$encoding : string|null = null
Return values
string

mb_strtoupper()

mb_strtoupper(string|null $string[, string|null $encoding = null ]) : string
Parameters
$string : string|null
$encoding : string|null = null
Return values
string

mb_substitute_character()

mb_substitute_character([string|int|null $substitute_character = null ]) : string|int|bool
Parameters
$substitute_character : string|int|null = null
Return values
string|int|bool

mb_substr()

mb_substr(string|null $string, int|null $start[, int|null $length = null ][, string|null $encoding = null ]) : string
Parameters
$string : string|null
$start : int|null
$length : int|null = null
$encoding : string|null = null
Return values
string

mb_stripos()

mb_stripos(string|null $haystack, string|null $needle[, int|null $offset = 0 ][, string|null $encoding = null ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
$encoding : string|null = null
Return values
int|false

mb_stristr()

mb_stristr(string|null $haystack, string|null $needle[, bool|null $before_needle = false ][, string|null $encoding = null ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$before_needle : bool|null = false
$encoding : string|null = null
Return values
string|false

mb_strrchr()

mb_strrchr(string|null $haystack, string|null $needle[, bool|null $before_needle = false ][, string|null $encoding = null ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$before_needle : bool|null = false
$encoding : string|null = null
Return values
string|false

mb_strrichr()

mb_strrichr(string|null $haystack, string|null $needle[, bool|null $before_needle = false ][, string|null $encoding = null ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$before_needle : bool|null = false
$encoding : string|null = null
Return values
string|false

mb_strripos()

mb_strripos(string|null $haystack, string|null $needle[, int|null $offset = 0 ][, string|null $encoding = null ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
$encoding : string|null = null
Return values
int|false

mb_strrpos()

mb_strrpos(string|null $haystack, string|null $needle[, int|null $offset = 0 ][, string|null $encoding = null ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
$encoding : string|null = null
Return values
int|false

mb_strstr()

mb_strstr(string|null $haystack, string|null $needle[, bool|null $before_needle = false ][, string|null $encoding = null ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$before_needle : bool|null = false
$encoding : string|null = null
Return values
string|false

mb_get_info()

mb_get_info([string|null $type = 'all' ]) : array<string|int, mixed>|string|int|false|null
Parameters
$type : string|null = 'all'
Return values
array<string|int, mixed>|string|int|false|null

mb_http_output()

mb_http_output([string|null $encoding = null ]) : string|bool
Parameters
$encoding : string|null = null
Return values
string|bool

mb_strwidth()

mb_strwidth(string|null $string[, string|null $encoding = null ]) : int
Parameters
$string : string|null
$encoding : string|null = null
Return values
int

mb_substr_count()

mb_substr_count(string|null $haystack, string|null $needle[, string|null $encoding = null ]) : int
Parameters
$haystack : string|null
$needle : string|null
$encoding : string|null = null
Return values
int

mb_output_handler()

mb_output_handler(string|null $string, int|null $status) : string
Parameters
$string : string|null
$status : int|null
Return values
string

mb_http_input()

mb_http_input([string|null $type = null ]) : array<string|int, mixed>|string|false
Parameters
$type : string|null = null
Return values
array<string|int, mixed>|string|false

mb_convert_variables()

mb_convert_variables(string|null $to_encoding, array<string|int, mixed>|string|null $from_encoding, mixed &$var, mixed ...&$vars) : string|false
Parameters
$to_encoding : string|null
$from_encoding : array<string|int, mixed>|string|null
$var : mixed
$vars : mixed
Return values
string|false

mb_ord()

mb_ord(string|null $string[, string|null $encoding = null ]) : int|false
Parameters
$string : string|null
$encoding : string|null = null
Return values
int|false

mb_chr()

mb_chr(int|null $codepoint[, string|null $encoding = null ]) : string|false
Parameters
$codepoint : int|null
$encoding : string|null = null
Return values
string|false

mb_scrub()

mb_scrub(string|null $string[, string|null $encoding = null ]) : string
Parameters
$string : string|null
$encoding : string|null = null
Return values
string

mb_str_split()

mb_str_split(string|null $string[, int|null $length = 1 ][, string|null $encoding = null ]) : array<string|int, mixed>
Parameters
$string : string|null
$length : int|null = 1
$encoding : string|null = null
Return values
array<string|int, mixed>

mb_str_pad()

mb_str_pad(string $string, int $length[, string $pad_string = ' ' ][, int $pad_type = STR_PAD_RIGHT ][, string|null $encoding = null ]) : string
Parameters
$string : string
$length : int
$pad_string : string = ' '
$pad_type : int = STR_PAD_RIGHT
$encoding : string|null = null
Return values
string

mb_ucfirst()

mb_ucfirst(string $string[, string|null $encoding = null ]) : string
Parameters
$string : string
$encoding : string|null = null
Return values
string

mb_lcfirst()

mb_lcfirst(string $string[, string|null $encoding = null ]) : string
Parameters
$string : string
$encoding : string|null = null
Return values
string

mb_trim()

mb_trim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

mb_ltrim()

mb_ltrim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

mb_rtrim()

mb_rtrim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

fdiv()

fdiv(float $num1, float $num2) : float
Parameters
$num1 : float
$num2 : float
Return values
float

preg_last_error_msg()

preg_last_error_msg() : string
Return values
string

str_contains()

str_contains(string|null $haystack, string|null $needle) : bool
Parameters
$haystack : string|null
$needle : string|null
Return values
bool

str_starts_with()

str_starts_with(string|null $haystack, string|null $needle) : bool
Parameters
$haystack : string|null
$needle : string|null
Return values
bool

str_ends_with()

str_ends_with(string|null $haystack, string|null $needle) : bool
Parameters
$haystack : string|null
$needle : string|null
Return values
bool

get_debug_type()

get_debug_type(mixed $value) : string
Parameters
$value : mixed
Return values
string

get_resource_id()

get_resource_id(mixed $resource) : int
Parameters
$resource : mixed
Return values
int

json_validate()

json_validate(string $json[, int $depth = 512 ][, int $flags = 0 ]) : bool
Parameters
$json : string
$depth : int = 512
$flags : int = 0
Return values
bool

mb_str_pad()

mb_str_pad(string $string, int $length[, string $pad_string = ' ' ][, int $pad_type = STR_PAD_RIGHT ][, string|null $encoding = null ]) : string
Parameters
$string : string
$length : int
$pad_string : string = ' '
$pad_type : int = STR_PAD_RIGHT
$encoding : string|null = null
Return values
string

stream_context_set_options()

stream_context_set_options(mixed $context, array<string|int, mixed> $options) : bool
Parameters
$context : mixed
$options : array<string|int, mixed>
Return values
bool

str_increment()

str_increment(string $string) : string
Parameters
$string : string
Return values
string

str_decrement()

str_decrement(string $string) : string
Parameters
$string : string
Return values
string

ldap_exop_sync()

ldap_exop_sync(mixed $ldap, string $request_oid[, string|null $request_data = null ][, array<string|int, mixed>|null $controls = null ][, mixed &$response_data = null ][, mixed &$response_oid = null ]) : bool
Parameters
$ldap : mixed
$request_oid : string
$request_data : string|null = null
$controls : array<string|int, mixed>|null = null
$response_data : mixed = null
$response_oid : mixed = null
Return values
bool

ldap_connect_wallet()

ldap_connect_wallet(string|null $uri, string $wallet, string $password[, int $auth_mode = GSLC_SSL_NO_AUTH ]) : mixed
Parameters
$uri : string|null
$wallet : string
$password : string
$auth_mode : int = GSLC_SSL_NO_AUTH

ldap_exop_sync()

ldap_exop_sync(Connection $ldap, string $request_oid[, string|null $request_data = null ][, array<string|int, mixed>|null $controls = null ][, mixed &$response_data = null ][, mixed &$response_oid = null ]) : bool
Parameters
$ldap : Connection
$request_oid : string
$request_data : string|null = null
$controls : array<string|int, mixed>|null = null
$response_data : mixed = null
$response_oid : mixed = null
Return values
bool

ldap_connect_wallet()

ldap_connect_wallet(string|null $uri, string $wallet, string $password[, int $auth_mode = GSLC_SSL_NO_AUTH ]) : Connection|false
Parameters
$uri : string|null
$wallet : string
$password : string
$auth_mode : int = GSLC_SSL_NO_AUTH
Return values
Connection|false

uuid_create()

uuid_create([mixed $uuid_type = UUID_TYPE_DEFAULT ]) : mixed
Parameters
$uuid_type : mixed = UUID_TYPE_DEFAULT

uuid_generate_md5()

uuid_generate_md5(mixed $uuid_ns, mixed $name) : mixed
Parameters
$uuid_ns : mixed
$name : mixed

uuid_generate_sha1()

uuid_generate_sha1(mixed $uuid_ns, mixed $name) : mixed
Parameters
$uuid_ns : mixed
$name : mixed

uuid_is_valid()

uuid_is_valid(mixed $uuid) : mixed
Parameters
$uuid : mixed

uuid_compare()

uuid_compare(mixed $uuid1, mixed $uuid2) : mixed
Parameters
$uuid1 : mixed
$uuid2 : mixed

uuid_is_null()

uuid_is_null(mixed $uuid) : mixed
Parameters
$uuid : mixed

uuid_type()

uuid_type(mixed $uuid) : mixed
Parameters
$uuid : mixed

uuid_variant()

uuid_variant(mixed $uuid) : mixed
Parameters
$uuid : mixed

uuid_time()

uuid_time(mixed $uuid) : mixed
Parameters
$uuid : mixed

uuid_mac()

uuid_mac(mixed $uuid) : mixed
Parameters
$uuid : mixed

uuid_parse()

uuid_parse(mixed $uuid) : mixed
Parameters
$uuid : mixed

uuid_unparse()

uuid_unparse(mixed $uuid) : mixed
Parameters
$uuid : mixed

uuid_create()

uuid_create([int|null $uuid_type = UUID_TYPE_DEFAULT ]) : string
Parameters
$uuid_type : int|null = UUID_TYPE_DEFAULT
Return values
string

uuid_generate_md5()

uuid_generate_md5(string|null $uuid_ns, string|null $name) : string
Parameters
$uuid_ns : string|null
$name : string|null
Return values
string

uuid_generate_sha1()

uuid_generate_sha1(string|null $uuid_ns, string|null $name) : string
Parameters
$uuid_ns : string|null
$name : string|null
Return values
string

uuid_is_valid()

uuid_is_valid(string|null $uuid) : bool
Parameters
$uuid : string|null
Return values
bool

uuid_compare()

uuid_compare(string|null $uuid1, string|null $uuid2) : int
Parameters
$uuid1 : string|null
$uuid2 : string|null
Return values
int

uuid_is_null()

uuid_is_null(string|null $uuid) : bool
Parameters
$uuid : string|null
Return values
bool

uuid_type()

uuid_type(string|null $uuid) : int
Parameters
$uuid : string|null
Return values
int

uuid_variant()

uuid_variant(string|null $uuid) : int
Parameters
$uuid : string|null
Return values
int

uuid_time()

uuid_time(string|null $uuid) : int
Parameters
$uuid : string|null
Return values
int

uuid_mac()

uuid_mac(string|null $uuid) : string
Parameters
$uuid : string|null
Return values
string

uuid_parse()

uuid_parse(string|null $uuid) : string
Parameters
$uuid : string|null
Return values
string

uuid_unparse()

uuid_unparse(string|null $uuid) : string
Parameters
$uuid : string|null
Return values
string

findTranslationFiles()

findTranslationFiles(mixed $originalFilePath, mixed $localeToAnalyze) : array<string|int, mixed>
Parameters
$originalFilePath : mixed
$localeToAnalyze : mixed
Return values
array<string|int, mixed>

calculateTranslationStatus()

calculateTranslationStatus(mixed $originalFilePath, mixed $translationFilePaths) : array<string|int, mixed>
Parameters
$originalFilePath : mixed
$translationFilePaths : mixed
Return values
array<string|int, mixed>

isTranslationCompleted()

isTranslationCompleted(array<string|int, mixed> $translationStatus) : bool
Parameters
$translationStatus : array<string|int, mixed>
Return values
bool

printTranslationStatus()

printTranslationStatus(mixed $originalFilePath, mixed $translationStatus, mixed $verboseOutput, mixed $includeCompletedLanguages) : mixed
Parameters
$originalFilePath : mixed
$translationStatus : mixed
$verboseOutput : mixed
$includeCompletedLanguages : mixed

extractLocaleFromFilePath()

extractLocaleFromFilePath(mixed $filePath) : mixed
Parameters
$filePath : mixed

extractTranslationKeys()

extractTranslationKeys(mixed $filePath) : array<string|int, mixed>
Parameters
$filePath : mixed
Return values
array<string|int, mixed>

findTransUnitMismatches()

Check whether the trans-unit id and source match with the base translation.

findTransUnitMismatches(array<string|int, mixed> $baseTranslationKeys, array<string|int, mixed> $translatedKeys) : array<string|int, mixed>
Parameters
$baseTranslationKeys : array<string|int, mixed>
$translatedKeys : array<string|int, mixed>
Return values
array<string|int, mixed>

printTable()

printTable(mixed $translations, mixed $verboseOutput, bool $includeCompletedLanguages) : mixed
Parameters
$translations : mixed
$verboseOutput : mixed
$includeCompletedLanguages : bool

esc()

esc(string $str) : string
Parameters
$str : string
Return values
string

dd()

dd(mixed ...$vars) : never
Parameters
$vars : mixed
Return values
never 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results